tmux.nvim

This plugin still under development

This plugin provides a framework to turns Neovim into terminal multiplexer (heavily based on tmux)

The intention of this plugin is to eliminate the need of tmux for a basic terminal multiplexing feature by leveraging Neovim split and tab features

For those who's on Windows, this could be a workaround for lack of tmux but only for terminal multiplexing

Table Of Contents

• Features
• Getting Started
• Configurations
• Installation
• Integration
• Supported Features
• Contributes
• License

Features

This are non exhaustive list of features available

• [x] Panes
• [x] Windows
• [x] Status bar¹
• [x] Copy mode¹
• [ ] (Detachable) Sessions²

1: Partially implemented
2: This requires Neovim to implement a server / client architecture which planned in neovim#10071

Getting Started

To quickly setup and run the first session of tmux.nvim

curl -fLo ~/.tmux.nvim/init.lua --create-dirs https://raw.githubusercontent.com/spywhere/tmux.nvim/main/tests/git.lua
nvim -u ~/.tmux.nvim/init.lua

This will download a basic configuration to ~/.tmux.nvim/init.lua and run it. In which, it will automatically install and setup the plugin using vim-plug.

Configurations

As the plugin still under development, please find the default configurations from following locations...

• Neovim configurations: lua/tmux/config.lua
• Status bar (built using tabline): lua/tmux/statusbar.lua
• Key bindings: lua/tmux/bindings.lua
• Available commands: lua/tmux/commands.lua

Please note that some options are opinionated and will be updated to match tmux's defaults later on

Installation

It is highly recommended to clone the repository (or download a zip file) and place it somewhere (~/.tmux.nvim would work too)

git clone https://github.com/spywhere/tmux.nvim ~/.tmux.nvim

or install using a plugin manager of your choice, for example:

" neovim 0.5 or later that supports lua
Plug 'spywhere/tmux.nvim'

Integration

Create a file named init.lua and place it somewhere (in this example, ~/.tmux.nvim/init.lua will be used)

-- if you're cloning the repository, you will need to add the plugin directory
--   to the 'runtimepath'
vim.opt.rtp:append('~/.tmux.nvim')

local tmux = require('tmux')

-- some configurations go here

tmux.start() -- this will start a terminal session

then, when you're ready to use Neovim as terminal multiplexer, just run

nvim -u ~/.tmux.nvim/init.lua

Supported Features

These are a list of features that required a certain version of Neovim

Neovim 0.7 or later is required for

• Status line on the bottom (above command line)

Neovim 0.5 or later is required for

• Basic functionality

Contributes

During the development, you can use the following command to automatically setup a working configurations to test the plugin...

make testrun

or

nvim -u tests/init.lua

Alternatively, if you wish to test the plugin through direct cloning, use...

make testrun-from-git

or

nvim -u tests/git.lua

License

Released under the MIT License