tmux/schasse.tmux-jump
1
0
Fork 0
mirror of https://github.com/schasse/tmux-jump.git synced 2026-09-10 07:06:15 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README.md

Browse source
This commit is contained in:
schasse 2020-02-10 21:15:25 +01:00
parent 95fb3305df
commit 0cc33ad179
No known key found for this signature in database
GPG key ID: 5497EFF3E3E1CACD
1 changed files with 31 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,12 +1,12 @@
<p align="center">
<img src="assets/tmux-jump-logo.png"
alt="Cursor jump for tmux."
alt="Vimium/Easymotion like cursor jump for tmux."
title="tmux-jump" />
</p>
[![Build Status](https://travis-ci.org/schasse/tmux-jump.svg?branch=master)](https://travis-ci.org/schasse/tmux-jump)
A fast way to jump wherever you want in your terminal without using the mouse. tmux-jump is written in ruby and can easily be installed via tpm.
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.
![tmux-jump](assets/tmux-jump-demo.gif)
@ -14,29 +14,49 @@ From now to then I think about how to improve my dev tools. Copy and pasting ins
## Requirements
* [tpm](https://github.com/tmux-plugins/tpm)
* ruby
* [tmux](https://github.com/tmux/tmux) >= 1.8
* [ruby](https://www.ruby-lang.org/) >= 2.3
## Installation
## Installation with [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 `tmux-prefix` + <kbd>I</kbd> to fetch the plugin and source it. You should now be able to use the plugin.
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
* `tmux-prefix` + <kbd>j</kbd> and enter the first character of a word.
* <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 copy mode.
tmux-jump can also be used in in any program and during copy mode.
## Similar Projects
[easymotion](https://github.com/easymotion/vim-easymotion)
[ace-jump-mode](https://github.com/winterTTr/ace-jump-mode)
* [vimium](https://vimium.github.io/)
* [easymotion](https://github.com/easymotion/vim-easymotion)
* [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode)