https://github.com/hkupty/nvimux

Neovim as a TMUX replacement
https://github.com/hkupty/nvimux

lua multiplexer neovim neovim-lua neovim-plugin tmux tmux-replacement

Last synced: 19 days ago
JSON representation

Neovim as a TMUX replacement

• Host: GitHub
• URL: https://github.com/hkupty/nvimux
• Owner: hkupty
• License: apache-2.0
• Created: 2016-03-08T15:16:55.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-05-19T09:08:39.000Z (over 2 years ago)
• Last Synced: 2024-07-31T20:51:53.797Z (4 months ago)
• Topics: lua, multiplexer, neovim, neovim-lua, neovim-plugin, tmux, tmux-replacement
• Language: Lua
• Size: 131 KB
• Stars: 443
• Watchers: 12
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• stars - hkupty/nvimux
• awesome-neovim - hkupty/nvimux - Neovim as tmux replacement. (Split and Window / Tmux)

README

        
# NVIMUX

[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#nvimux:matrix.org)

[![Sponsor me](https://img.shields.io/github/sponsors/hkupty?style=flat-square)](https://github.com/sponsors/hkupty)

Nvimux allows neovim to work as a tmux replacement.

It does so by mapping tmuxs keybindings to neovim, using its windows, buffers and terminals.

### Support nvimux

Support nvimux development by sending me some bitcoins at `1P4iGMqrBcjdgicC1EdQFA4qF91LtRri1Y`.

## Configuring

Nvimux is built on [lua](https://github.com/neovim/neovim/pull/4411), meaning that you must use a somewhat recent version of neovim.

For the older version, based on viml, refer to [the legacy branch](https://github.com/hkupty/nvimux/tree/legacy). The legacy branch won't be maintained but will be kept for those who prefer it.

To configure nvimux, you can use both lua and viml to configure, though the first is much preferred.

A lua-based configuration for nvimux is as follows:

```lua

lua << EOF

-- Nvimux configuration

local nvimux = require('nvimux')

nvimux.setup{

  config = {

    prefix = '',

  },

  bindings = {

    {{'n', 'v', 'i', 't'}, 's', nvimux.commands.horizontal_split},

    {{'n', 'v', 'i', 't'}, 'v', nvimux.commands.vertical_split},

  }

}

EOF

```

In case you don't set configuration options, please do run the following for nvimux to work:

```lua

lua require('nvimux').setup{}

```

## Credits & Stuff

This plugin is developed and maintained by [Henry Kupty](http://github.com/hkupty) and it's completely free to use.

The rationale behind the idea is described [in this article](http://hkupty.github.io/2016/Ditching-TMUX/).

Consider helping by opening issues, Pull Requests or influencing your friends and colleagues to use!