summaryrefslogtreecommitdiff
path: root/plugins/percol/README.md
blob: 78c881f550a91fd318dbfa775c6570efa77cb66a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# percol

Provides some useful function to make [percol](https://github.com/mooz/percol) work with zsh history and
the [jump plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/jump), optionally.

To use it, add `percol` to the plugins array in your zshrc:

```zsh
plugins=(... percol)
```

## Requirements

- `percol`: install with `pip install percol`.

- (_Optional_) [`jump`](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/jump) plugin: needs to be
  enabled before the `percol` plugin.

## Usage

- <kbd>CTRL-R</kbd> (bound to `percol_select_history`): you can use it to grep your history with percol.

- <kbd>CTRL-B</kbd> (bound to `percol_select_marks`): you can use it to grep your jump bookmarks with percol.