mirror of https://github.com/preservim/vimux synced 2024-11-04 18:00:10 +00:00

Go to file

Ton van den Heuvel 8ff22883bd Identify a pane by its window and its pane index By identifying a pane by both its window and pane index, VimuxCloseRunner() will always close the correct pane, even in case VimuxCloseRunner() is called from a Vim instance in a different window than the current window.		2014-01-21 13:57:54 +01:00
doc	Update docs to reflect close functions. Fixes #89	2013-11-28 23:28:16 -08:00
plugin	Identify a pane by its window and its pane index	2014-01-21 13:57:54 +01:00
.gitignore	rm tags file and .gitignore it.	2012-05-31 17:44:50 +02:00
LICENSE	Create LICENSE	2013-12-13 08:46:05 -08:00
README.mkd	Update README to mention Vimix (Elixir Mix integration)	2013-12-01 20:02:35 -06:00

README.mkd

vimux

Easily interact with tmux from vim.

What inspired me to write vimux was tslime.vim, a plugin that lets you send input to tmux. While tslime.vim works well, I felt it wasn't optimized for my primary use case which was having a smaller tmux pane that I would use to run tests or play with a REPL.

My goal with vimux is to make interacting with tmux from vim effortless. By default when you call VimuxRunCommand vimux will create a 20% tall horizontal pane under your current tmux pane and execute a command in it without losing focus of vim. Once that pane exists whenever you call VimuxRunCommand again the command will be executed in that pane. As I was using vimux myself I wanted to rerun commands over and over. An example of this was running the current file through rspec. Rather than typing that over and over I wrote VimuxRunLastCommand that will execute the last command you called with VimuxRunCommand.

Other auxiliary functions and the ones I talked about above can be found bellow with a full description and example key binds for your vimrc.

Installation

With vim-bundle: vim-bundle install benmills/vimux

Otherwise download the latest tarball, extract it and move plugin/vimux.vim inside ~/.vim/plugin. If you're using pathogen, then move the entire folder extracted from the tarball into ~/.vim/bundle.

Notes:

Vimux assumes a tmux version >= 1.5. Some older versions might work but it is recommeded to use at least version 1.5.

Platform-specific Plugins

vim-vroom runner for rspec, cucumber and test/unit; vimux support via g:vroom_use_vimux
vimux-ruby-test a set of commands to easily run ruby tests
vimux-cucumber run Cucumber Features through Vimux
vim-turbux Turbo Ruby testing with tmux
vimux-pyutils A set of functions for vimux that allow to run code blocks in ipython
vimux-nose-test Run nose tests in vimux
vimux-golang Run go tests in vimux
vimux-zeus Run zeus commands in vimux
vimix Run Elixir mix commands in vimux

Usage

The full documentation is available online and accessible inside vim :help vimux