https://github.com/viniciusgerevini/tmux-runner.vim
Interact with Tmux without leaving Vim
https://github.com/viniciusgerevini/tmux-runner.vim
tmux vim vim-plugin
Last synced: 2 months ago
JSON representation
Interact with Tmux without leaving Vim
- Host: GitHub
- URL: https://github.com/viniciusgerevini/tmux-runner.vim
- Owner: viniciusgerevini
- License: mit
- Created: 2019-07-05T06:57:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-25T06:52:28.000Z (over 5 years ago)
- Last Synced: 2025-02-03T16:47:37.035Z (4 months ago)
- Topics: tmux, vim, vim-plugin
- Language: Vim script
- Homepage:
- Size: 43 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TmuxRunner.vim
This plugin allows you to interact with Tmux without leaving Vim.
It was inspired by [Vimux](https://github.com/benmills/vimux) (used as reference), which has similar features, but hasn't been accepting updates for a while.
Some of TmuxRunner main improvements are:
- Command prompt has command line completion
- You can choose your runner manually by providing its id, name or index
- Changing layouts and creating new panes do not affect the current runner
- Various options for auto-selecting pane as runner: last active, nearest, new
# Installation
[VimPlug](https://github.com/junegunn/vim-plug): `Plug 'viniciusgerevini/tmux-runner.vim'`
[Vundle](https://github.com/VundleVim/Vundle.vim): `Plugin 'viniciusgerevini/tmux-runner.vim'`
[Pathogen](https://github.com/tpope/vim-pathogen) `cd ~/.vim/bundle && git clone https://github.com/viniciusgerevini/tmux-runner.vim`
Manual Instalation: copy `./plugin/tmux-runner.vim` to your plugins folder.
# Usage
*Mappings example:*
```
" Prompt command
map tp :TmuxRunnerPromptCommand
" Open TmuxRunner prompt with current buffer name
map tr :TmuxRunnerPromptCommand bufname("%")
" Run last command executed
map tl :TmuxRunnerRunLastCommand
" Edit last command and rerun
map te :TmuxRunnerEditCommand
" Inspect runner pane
map ti :TmuxRunnerInspect
" Scroll down pane
map td :TmuxRunnerScrollDown
" Scroll up pane
map tu :TmuxRunnerScrollUp
" Zoom the tmux runner pane
map tz :TmuxRunnerZoom
" Close pane
map tq :TmuxRunnerClose
" Clear pane
map tc :TmuxRunnerClear
" Stop execution in pane
map tx :TmuxRunnerStop
" Set new pane as runner
map ts :TmuxRunnerPromptRunner
```
*Options:*
```
" Runner pane size
let g:TmuxRunnerSize = 20
" Runner pane split orientation
let g:TmuxRunnerOrientation = 'v'
" Define how new runners are chosen
let g:TmuxRunnerNewRunnerMode = 'new'
" Custom order for 'nearest' mode
let g:TmuxRunnerNearestSelectionOrder = ['down-of', 'right-of']
" Tmux executable to use
let g:TmuxRunnerExecutable = 'tmate'
```
For more information `:help tmux-runner` or online [docs](./doc/tmux-runner.txt).
# License
MIT