https://github.com/nathom/tmux.nvim

A tiny plugin for seamless switching between vim splits and tmux panes
https://github.com/nathom/tmux.nvim

lightweight lua neovim tmux

Last synced: 13 days ago
JSON representation

A tiny plugin for seamless switching between vim splits and tmux panes

• Host: GitHub
• URL: https://github.com/nathom/tmux.nvim
• Owner: nathom
• License: mit
• Created: 2021-08-13T01:02:14.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-15T19:36:29.000Z (about 3 years ago)
• Last Synced: 2024-10-11T00:49:00.152Z (about 1 month ago)
• Topics: lightweight, lua, neovim, tmux
• Language: Lua
• Homepage:
• Size: 6.84 KB
• Stars: 45
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tmux.nvim

A *very* tiny plugin that lets you seamlessly navigate between tmux panes and vim splits.

## Installation

```lua

-- Using packer.nvim

use("nathom/tmux.nvim")

```

If you're a stickler for lazy loading like I am, use a dedicated

tmux mapping file in `~/.config/nvim/lua/config/tmux.lua` and

put the following in your plugin config instead:

```lua

use({ "nathom/tmux.nvim", config = [[require("config.tmux")]] })

```

## Usage

First and foremost, you need to add the following to your `.tmux.conf`

```tmux

# Smart pane switching with awareness of Vim splits.

# From https://github.com/christoomey/vim-tmux-navigator

is_vim="ps -o state= -o comm= -t '#{pane_tty}' \

| grep -iqE '^[^TXZ ]+ +(\\S+\\/)?g?(view|n?vim?x?)(diff)?$'"

bind-key -n Left if-shell "$is_vim" "send-keys Left" "select-pane -L"

bind-key -n Down if-shell "$is_vim" "send-keys Down" "select-pane -D"

bind-key -n Up if-shell "$is_vim" "send-keys Up" "select-pane -U"

bind-key -n Right if-shell "$is_vim" "send-keys Right" "select-pane -R"

```

`tmux.nvim` exposes 4 functions that you can map to any key of

your choosing—`move_left`, `move_right`, `move_up`, and `move_down`.

Then, put the following in your config:

```lua

local map = vim.api.nvim_set_keymap

map("n", "", [[lua require('tmux').move_left()]])

map("n", "", [[lua require('tmux').move_down()]])

map("n", "", [[lua require('tmux').move_up()]])

map("n", "", [[lua require('tmux').move_right()]])

```

If you don't want to use arrow keys, use the following template, replacing the `{side}` with the appropriate key name in Vim and tmux.

```tmux

# tmux.conf

is_vim="ps -o state= -o comm= -t '#{pane_tty}' \

| grep -iqE '^[^TXZ ]+ +(\\S+\\/)?g?(view|n?vim?x?)(diff)?$'"

bind-key -n {left} if-shell "$is_vim" "send-keys {left}" "select-pane -L"

bind-key -n {down} if-shell "$is_vim" "send-keys {down}" "select-pane -D"

bind-key -n {up} if-shell "$is_vim" "send-keys {up}" "select-pane -U"

bind-key -n {right} if-shell "$is_vim" "send-keys {right}" "select-pane -R"

```

```lua

-- init.lua or config/tmux.lua

local map = vim.api.nvim_set_keymap

map("n", "{left}", [[lua require('tmux').move_left()]])

map("n", "{down}", [[lua require('tmux').move_down()]])

map("n", "{up}", [[lua require('tmux').move_up()]])

map("n", "{right}", [[lua require('tmux').move_right()]])

```