README.md 1.39 KB
Newer Older
Maxime Brunet's avatar
Maxime Brunet committed
1
2
3
4
# fzf

This plugin enables [junegunn's fzf](https://github.com/junegunn/fzf) fuzzy auto-completion and key bindings

5
6
7
8
9
10
11
12
13
To use it, add `fzf` to the plugins array in your zshrc file:
```zsh
plugins=(... fzf)
```

## Settings

Add these before the `plugins=()` line in your zshrc file:

Maxime Brunet's avatar
Maxime Brunet committed
14
15
```zsh
# Set fzf installation directory path
16
17
18
19
# export FZF_BASE=/path/to/fzf/install/dir

# Uncomment to set the FZF_DEFAULT_COMMAND
# export FZF_DEFAULT_COMMAND='<your fzf default commmand>'
Maxime Brunet's avatar
Maxime Brunet committed
20
21

# Uncomment the following line to disable fuzzy completion
22
# DISABLE_FZF_AUTO_COMPLETION="true"
Maxime Brunet's avatar
Maxime Brunet committed
23
24

# Uncomment the following line to disable key bindings (CTRL-T, CTRL-R, ALT-C)
25
# DISABLE_FZF_KEY_BINDINGS="true"
Maxime Brunet's avatar
Maxime Brunet committed
26
```
27
28
29
30
31
32
33

| Setting                     | Example value              | Description                                                 |
|-----------------------------|----------------------------|-------------------------------------------------------------|
| FZF_BASE                    | `/path/to/fzf/install/dir` | Set fzf installation directory path (**export**)            |
| FZF_DEFAULT_COMMAND         | `fd --type f`              | Set default command to use when input is tty (**export**)   |
| DISABLE_FZF_AUTO_COMPLETION | `true`                     | Set whether to load fzf auto-completion                     |
| DISABLE_FZF_KEY_BINDINGS    | `true`                     | Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C) |