tmux-thumbs/README.md

147 lines
4.7 KiB
Markdown
Raw Normal View History

2019-02-04 19:56:14 +00:00
# tmux-thumbs
2019-02-04 21:40:45 +00:00
2019-02-28 23:12:53 +00:00
![](https://travis-ci.com/fcsonline/tmux-thumbs.svg?branch=master)
2019-02-28 18:51:33 +00:00
A lightning fast version of [tmux-fingers](https://github.com/Morantron/tmux-fingers) written in [Rust](https://www.rust-lang.org/) for copy pasting with vimium/vimperator like hints.
:warning: This plugin is active development.
## Matched patterns
- File paths
- File in diff
- Git SHAs
- Colors in hex
- Numbers ( 4+ digits )
- Hex numbers
- IP4 addresses
- kubernetes resources
- UUIDs
## Install
The easiest way right now is to install with [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html):
```
cargo install tmux-thumbs
tmux-thumbs -
```
or download the source code and compile it:
```
git clone git@github.com:fcsonline/tmux-thumbs.git && cd tmux-thumbs
cargo build --release
```
2019-03-09 22:22:13 +00:00
## Demo
[![demo](https://asciinema.org/a/232775.png)](https://asciinema.org/a/232775?autoplay=1)
2019-02-28 18:51:33 +00:00
## Configuration
All `tmux-thumbs` configuration works settings custom paramenters to `tmux-thumbs` command.
Example:
```
tmux-thumbs -a qwerty -r -u
```
You can review all available options executing:
```
> tmux-thumbs --help
2019-03-07 17:58:18 +00:00
tmux-thumbs 0.2.2
2019-02-28 18:51:33 +00:00
A lightning fast version of tmux-fingers, copy/pasting tmux like vimium/vimperator
USAGE:
tmux-thumbs [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-r, --reverse Reverse the order for assigned hints
-u, --unique Don't show duplicated hints for the same match
-V, --version Prints version information
OPTIONS:
-a, --alphabet <alphabet> Sets the alphabet [default: qwerty]
--bg-color <background_color> Sets the background color for matches [default: black]
2019-03-02 18:49:00 +00:00
--command <command> Pick command [default: tmux set-buffer {}]
2019-02-28 18:51:33 +00:00
--fg-color <foreground_color> Sets the foregroud color for matches [default: green]
--hint-bg-color <hint_background_color> Sets the background color for hints [default: black]
--hint-fg-color <hint_foreground_color> Sets the foregroud color for hints [default: yellow]
-p, --position <position> Hint position [default: left]
2019-03-07 17:58:18 +00:00
-x, --regexp <regexp>... Use this regexp as extra pattern to match
2019-02-28 18:51:33 +00:00
--select-fg-color <select_foreground_color> Sets the foregroud color for selection [default: blue]
2019-03-02 18:49:00 +00:00
--upcase-command <upcase_command> Upcase command [default: tmux paste-buffer]
2019-02-28 18:51:33 +00:00
```
### Arguments
- **alphabet:** Choose which set of characters is used to build hints. Default [qwerty]
- **reverse:** Choose in which direction you want to assign hints. Useful to get shorter hints closer.
- **unique:** Choose if you want to assign the same hint for the same matched strings.
- **position:** Choose where do you want to show the hint in the matched string. Options (left, right). Default [left]
2019-03-07 17:58:18 +00:00
- **regexp:** Add extra pattern to match. This paramenter can have multiple instances.
2019-03-02 18:49:00 +00:00
- **command:** Choose whish command execute when you press a hint
- **upcase-command:** Choose which command execute when you press a upcase hint
2019-02-28 18:51:33 +00:00
- **bg-color:** Sets the background color for matches [default: black]
- **fg-color:** Sets the foregroud color for matches [default: green]
- **hint-bg-color:** Sets the background color for hints [default: black]
- **hint-fg-color:** Sets the foregroud color for hints [default: yellow]
- **select-fg-color:** Sets the foregroud color for selection [default: blue]
## Alphabets
2019-02-28 23:11:16 +00:00
This is the list of available alphabets:
2019-02-28 18:51:33 +00:00
- `numeric`: 1234567890
- `abcd`: abcd
- `qwerty`: asdfqwerzxcvjklmiuopghtybn
- `qwerty-homerow`: asdfjklgh
- `qwerty-left-hand`: asdfqwerzcxv
- `qwerty-right-hand`: jkluiopmyhn
- `azerty`: qsdfazerwxcvjklmuiopghtybn
- `azerty-homerow`: qsdfjkmgh
- `azerty-left-hand`: qsdfazerwxcv
- `azerty-right-hand`: jklmuiophyn
- `qwertz`: asdfqweryxcvjkluiopmghtzbn
- `qwertz-homerow`: asdfghjkl
- `qwertz-left-hand`: asdfqweryxcv
- `qwertz-right-hand`: jkluiopmhzn
- `dvorak`: aoeuqjkxpyhtnsgcrlmwvzfidb
- `dvorak-homerow`: aoeuhtnsid
- `dvorak-left-hand`: aoeupqjkyix
- `dvorak-right-hand`: htnsgcrlmwvz
- `colemak`: arstqwfpzxcvneioluymdhgjbk
- `colemak-homerow`: arstneiodh
- `colemak-left-hand`: arstqwfpzxcv
- `colemak-right-hand`: neioluymjhk
2019-02-28 23:11:16 +00:00
## Colors
This is the list of available colors:
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- default
2019-02-28 18:51:33 +00:00
## Extra features
- **Arrow navigation:** You can use the arrows to move arround between all matched items.
- **Auto paste:** If your last typed hint character is uppercase, you are going to pick and paste the desired hint.
# License
[MIT](https://github.com/fcsonline/tmux-thumbs/blob/master/LICENSE)