itsscb/harpoon
1
0
Fork 0
mirror of https://github.com/ThePrimeagen/harpoon.git synced 2025-07-14 01:50:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): added documentation for tmux module

Browse Source
This commit is contained in:
Pranav Rao 2021-11-23 15:02:19 -05:00
parent 02e91845bb
commit 9e5634ff53
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -126,6 +126,22 @@ Just call the following function to edit commands inside the list
lua require('harpoon.cmd-ui').toggle_quick_menu() lua require('harpoon.cmd-ui').toggle_quick_menu()
``` ```
#### Tmux Integration
Harpoon also supports all terminal operations (see above) with tmux terminals.
The configuration for using tmux is exactly the same as the config for using nvim
terminals. To use tmux terminals instead of nvim terminals, simply replace
`harpoon.term` with `harpoon.tmux` in your require statement.
For example:
```lua
-- goes to the first tmux window
lua require("harpoon.tmux").gotoTerminal(1)
-- sends a command to the first tmux window
lua require("harpoon.tmux").sendCommand(1, "ls -la")
```
### Setup ### Setup
Setup should be called once. Setup should be called once.
@ -146,6 +162,7 @@ require("harpoon").setup({
save_on_toggle = false, save_on_toggle = false,
save_on_change = true, save_on_change = true,
enter_on_sendcmd = false, enter_on_sendcmd = false,
tmux_autoclose_windows = false,
excluded_filetypes = { "harpoon" } excluded_filetypes = { "harpoon" }
}, },
... your other configs ... ... your other configs ...
@ -160,6 +177,8 @@ require("harpoon").setup({
what I have found). what I have found).
* `enter_on_sendcmd` will set harpoon to run the command immediately as it's * `enter_on_sendcmd` will set harpoon to run the command immediately as it's
passed to the terminal when calling `sendCommand`. passed to the terminal when calling `sendCommand`.
* `tmux_autoclose_windows` will close any tmux windows harpoon that harpoon creates
when you close Neovim.
* `excluded_filetypes` filetypes that you want to prevent from adding to the harpoon list menu. * `excluded_filetypes` filetypes that you want to prevent from adding to the harpoon list menu.
#### Preconfigured Terminal Commands #### Preconfigured Terminal Commands