summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/fzf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/fzf/README.md')
-rw-r--r--oh-my-zsh/plugins/fzf/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/fzf/README.md b/oh-my-zsh/plugins/fzf/README.md
new file mode 100644
index 0000000..beedf46
--- /dev/null
+++ b/oh-my-zsh/plugins/fzf/README.md
@@ -0,0 +1,52 @@
+# fzf
+
+This plugin tries to find [junegunn's fzf](https://github.com/junegunn/fzf) based on where
+it's been installed, and enables its fuzzy auto-completion and key bindings.
+
+To use it, add `fzf` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... fzf)
+```
+
+## Settings
+
+All these settings should go in your zshrc file, before Oh My Zsh is sourced.
+
+### `FZF_BASE`
+
+Set to fzf installation directory path:
+
+```zsh
+export FZF_BASE=/path/to/fzf/install/dir
+```
+
+### `FZF_DEFAULT_COMMAND`
+
+Set default command to use when input is tty:
+
+```zsh
+export FZF_DEFAULT_COMMAND='<your fzf default command>'
+```
+
+If not set, the plugin will try to set it to these, in the order in which they're found:
+
+- [`fd`](https://github.com/sharkdp/fd)
+- [`rg`](https://github.com/BurntSushi/ripgrep)
+- [`ag`](https://github.com/ggreer/the_silver_searcher)
+
+### `DISABLE_FZF_AUTO_COMPLETION`
+
+Set whether to load fzf auto-completion:
+
+```zsh
+DISABLE_FZF_AUTO_COMPLETION="true"
+```
+
+### `DISABLE_FZF_KEY_BINDINGS`
+
+Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C):
+
+```zsh
+DISABLE_FZF_KEY_BINDINGS="true"
+```