https://github.com/bronzehedwick/vim-primary-terminal
Simple terminal management for neovim
https://github.com/bronzehedwick/vim-primary-terminal
neovim terminal vim vim-plugin vim-plugins
Last synced: 11 months ago
JSON representation
Simple terminal management for neovim
- Host: GitHub
- URL: https://github.com/bronzehedwick/vim-primary-terminal
- Owner: bronzehedwick
- Created: 2019-11-15T20:30:05.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-03-14T17:23:25.000Z (over 4 years ago)
- Last Synced: 2025-04-24T02:03:47.740Z (about 1 year ago)
- Topics: neovim, terminal, vim, vim-plugin, vim-plugins
- Language: Vim script
- Size: 28.3 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Primary Terminal
Simple terminal management for Neovim.
## Why another terminal manager?
I wanted something very minimal, that only took control of a single
`:terminal` instance at a time; this served my use case well.
I prefer the flyweight simplicity of that approach, since 90% of the
time I only want to interact with the same terminal instance.
If I do need another one, it's easy enough to create another un-managed
`:terminal`, or a process-specific `:e term://my-command`.
## Installation
If you're using a plugin manager, follow the instructions in their
documentation.
For example, if you're using
[Packer](https://github.com/wbthomason/packer.nvim), you would add the
following to your configuration:
```lua
use 'bronzehedwick/vim-primary-terminal'
```
Otherwise, use [native package
support](https://neovim.io/doc/user/repeat.html#packages)
by cloning vim-primary-terminal to
[`packpath`](https://neovim.io/doc/user/options.html#packpath).
```sh
git clone https://github.com/bronzehedwick/vim-primary-terminal \
${XDG_DATA_HOME:-$HOME/.local/share}/nvim/site/pack/plugins/start/vim-primary-terminal
```
## Commands
vim-primary-terminal provides the following commands:
- `:PrimaryTerminalOpen`: Open the primary terminal in the current window.
- `:PrimaryTerminalOpenSplit`: Open the primary terminal in a horizontal split window.
- `:PrimaryTerminalOpenVsplit`: Open the primary terminal in a vertical split window.
- `:T[!] {args}`: Pass `{args}` to the primary terminal. If `!` is passed, load the primary terminal in the preview window as well.
- `:Tkill`: Kill the current process running in the primary terminal by sending Ctrl+c
## Key mappings
vim-primary-terminal provides the following
[``](https://neovim.io/doc/user/map.html#%3CPlug%3E) mappings:
- `(PrimaryTerminalOpen)`: Execute `:PrimaryTerminalOpen`
- `(PrimaryTerminalOpenSplit)`: Execute `:PrimaryTerminalOpenSplit`
- `(PrimaryTerminalOpenVsplit)`: Execute `:PrimaryTerminalOpenVsplit`
- `(PrimaryTerminalOpenDynamic)`: Execute `:PrimaryTerminalOpenDynamic`
Using `` allows you to customize if and what key sequences to map to.
However, if you don't have a preference, add the following mappings to
your `init.vim`:
```vim
nmap t (PrimaryTerminalOpen)
nmap r (PrimaryTerminalOpenSplit)
nmap y (PrimaryTerminalOpenVsplit)
nmap d (PrimaryTerminalOpenDynamic)
```
See [`:help primary-terminal`](./doc/primary-terminal.txt) for more.
## Similar projects
- [neoterm](https://github.com/kassio/neoterm)
- [FTerm](https://github.com/numToStr/FTerm.nvim)
- [terminus](https://github.com/brettanomyces/nvim-terminus)
- [editcommand](https://github.com/brettanomyces/nvim-editcommand)
- [nuake](https://github.com/Lenovsky/nuake)
- [split term](https://github.com/vimlab/split-term.vim)
## License
Copyright © 2019–2022 Chris DeLuca
Licensed under the same terms as Vim itself.