mirror of
https://github.com/schasse/tmux-jump.git
synced 2026-09-10 07:06:15 -04:00
106 lines
3.4 KiB
Markdown
106 lines
3.4 KiB
Markdown
<p align="center">
|
|
<img src="assets/tmux-jump-logo.png"
|
|
alt="Vimium/Easymotion like cursor jump for tmux."
|
|
title="tmux-jump" />
|
|
</p>
|
|
|
|
[](https://travis-ci.org/schasse/tmux-jump)
|
|
|
|
A fast way to jump wherever you want in your terminal without using the mouse. A plugin similar to [vimium](https://vimium.github.io/) and [easymotion](https://github.com/easymotion/vim-easymotion) but for tmux. tmux-jump is written in ruby and can easily be installed via tpm.
|
|
|
|
|
|
|
|
From now to then I think about how to improve my dev tools. Copy and pasting inside the terminal is something I do everyday, all the time. This is one of the most obvious things make more efficient. [tmux-yank](https://github.com/tmux-plugins/tmux-yank) improved the situation a lot. Though, it felt still annoying to get to the string I wanted to copy. Either I used to enter tmux copy mode and moved the cursor to the string or I used the mouse. I looked for a plugin such as easymotion for vim or ace jump for emacs, but I couldn't find one. So I decided to write my own tmux plugin.
|
|
|
|
## Requirements
|
|
|
|
* [tmux](https://github.com/tmux/tmux) >= 3.1
|
|
* [ruby](https://www.ruby-lang.org/) >= 2.3
|
|
|
|
## Installation via [TPM](https://github.com/tmux-plugins/tpm)
|
|
|
|
Add plugin to the list of TPM plugins in `~/.tmux.conf`:
|
|
|
|
```
|
|
set -g @plugin 'schasse/tmux-jump'
|
|
```
|
|
Hit <kbd>tmux-prefix</kbd> + <kbd>I</kbd> to fetch the plugin and source it. You should now be able to use the plugin.
|
|
|
|
## Manual Installation
|
|
|
|
Clone the repository:
|
|
|
|
```
|
|
git clone https://github.com/schasse/tmux-jump ~/.tmux-jump
|
|
```
|
|
|
|
Add the following to `.tmux.conf`:
|
|
|
|
```
|
|
run-shell ~/.tmux-jump/tmux-jump.tmux
|
|
```
|
|
|
|
Reload tmux:
|
|
|
|
```
|
|
tmux source-file ~/.tmux.conf
|
|
```
|
|
|
|
## Usage
|
|
|
|
* <kbd>tmux-prefix</kbd> + <kbd>j</kbd> and enter the first character of a word.
|
|
* The screen will rerender and highlight the keys to press to jump to the word.
|
|
* Type the key sequence of the word to jump to.
|
|
* The cursor moves to the word.
|
|
|
|
tmux-jump can also be used in in any program and during copy mode.
|
|
|
|
You can customize the key binding in your `.tmux.conf`:
|
|
|
|
```
|
|
set -g @jump-key 's'
|
|
```
|
|
|
|
You can also customize foreground and background color:
|
|
```
|
|
set -g @jump-bg-color '\e[0m\e[90m'
|
|
set -g @jump-fg-color '\e[1m\e[31m'
|
|
```
|
|
|
|
And the keys position:
|
|
```
|
|
# keys will overlap with the word (default)
|
|
set -g @jump-keys-position 'left'
|
|
|
|
# keys will be at the left of the word without overlap
|
|
set -g @jump-keys-position 'off_left'
|
|
```
|
|
|
|
And the keys:
|
|
```
|
|
set -g @jump-keys 'aoeuidhtns'
|
|
```
|
|
|
|
The case sensitivity setting can be configured as well. The default is
|
|
case-insensitive search. With casesensitive tmux-jump will only match the
|
|
search character if the case matches. With smartcase, tmux-jump will match the
|
|
search character case-insensitively if the search character is lowercase, and
|
|
case-sensitively if the search character is uppercase.
|
|
|
|
```
|
|
# case-insensitive search (default)
|
|
set -g @jump-key-case 'ignorecase'
|
|
|
|
# case-sensitive only when the search character is uppercase
|
|
set -g @jump-key-case 'smartcase'
|
|
|
|
# always case-sensitive
|
|
set -g @jump-key-case 'casesensitive'
|
|
```
|
|
|
|
## Similar Projects
|
|
|
|
* [vimium](https://vimium.github.io/)
|
|
* [easymotion](https://github.com/easymotion/vim-easymotion)
|
|
* [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode)
|