fzf/README.md

432 lines
13 KiB
Markdown
Raw Normal View History

2015-09-14 06:48:44 +00:00
<img src="https://raw.githubusercontent.com/junegunn/i/master/fzf.png" height="170" alt="fzf - a command-line fuzzy finder"> [![travis-ci](https://travis-ci.org/junegunn/fzf.svg?branch=master)](https://travis-ci.org/junegunn/fzf)
2015-03-15 17:49:09 +00:00
===
2013-10-23 01:26:55 +00:00
2015-03-15 01:57:09 +00:00
fzf is a general-purpose command-line fuzzy finder.
2013-10-23 01:26:55 +00:00
2013-10-29 13:14:11 +00:00
![](https://raw.github.com/junegunn/i/master/fzf.gif)
2013-10-28 06:50:46 +00:00
2015-03-15 01:57:09 +00:00
Pros
----
2015-05-08 15:26:34 +00:00
- No dependencies
2015-03-15 01:57:09 +00:00
- Blazingly fast
- The most comprehensive feature set
2016-09-12 19:11:28 +00:00
- Flexible layout using tmux panes
2015-03-15 01:57:09 +00:00
- Batteries included
2015-04-11 15:44:41 +00:00
- Vim/Neovim plugin, key bindings and fuzzy auto-completion
2013-10-23 01:26:55 +00:00
Installation
------------
2016-09-12 19:11:28 +00:00
fzf project consists of the following components:
2015-02-17 04:15:16 +00:00
- `fzf` executable
- `fzf-tmux` script for launching fzf in a tmux pane
2015-02-17 04:15:16 +00:00
- Shell extensions
- Key bindings (`CTRL-T`, `CTRL-R`, and `ALT-C`) (bash, zsh, fish)
2015-05-09 11:15:14 +00:00
- Fuzzy auto-completion (bash, zsh)
2015-04-11 02:28:30 +00:00
- Vim/Neovim plugin
2015-02-17 04:15:16 +00:00
2016-09-12 19:11:28 +00:00
You can [download fzf executable][bin] alone if you don't need the extra
stuff.
2015-02-17 04:15:16 +00:00
[bin]: https://github.com/junegunn/fzf-bin/releases
2016-09-12 19:11:28 +00:00
### Using git
2015-02-17 04:15:16 +00:00
Clone this repository and run
2013-10-23 01:26:55 +00:00
[install](https://github.com/junegunn/fzf/blob/master/install) script.
```sh
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
~/.fzf/install
2013-10-23 01:26:55 +00:00
```
2016-09-12 19:11:28 +00:00
### Using Homebrew
2015-02-17 04:15:16 +00:00
On OS X, you can use [Homebrew](http://brew.sh/) to install fzf.
2015-02-17 04:15:16 +00:00
```sh
2015-11-03 18:13:22 +00:00
brew install fzf
2013-10-23 01:26:55 +00:00
2015-04-02 16:21:50 +00:00
# Install shell extensions
2015-11-03 18:13:22 +00:00
/usr/local/opt/fzf/install
2015-02-17 04:15:16 +00:00
```
2014-03-31 01:15:38 +00:00
2016-09-12 19:11:28 +00:00
### Vim plugin
2013-10-23 01:26:55 +00:00
2016-09-12 19:11:28 +00:00
You can manually add the directory to `&runtimepath` as follows,
2013-10-23 01:26:55 +00:00
2014-03-04 02:25:50 +00:00
```vim
2016-09-12 19:11:28 +00:00
" If installed using git
2014-03-04 02:25:50 +00:00
set rtp+=~/.fzf
2016-09-12 19:11:28 +00:00
" If installed using Homebrew
set rtp+=/usr/local/opt/fzf
2014-03-04 02:25:50 +00:00
```
2013-10-23 01:26:55 +00:00
2016-09-12 19:11:28 +00:00
But it's recommended that you use a plugin manager like
[vim-plug](https://github.com/junegunn/vim-plug).
2014-09-02 04:06:05 +00:00
```vim
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
2014-09-02 04:06:05 +00:00
```
2013-10-23 01:26:55 +00:00
2016-09-12 19:11:28 +00:00
### Upgrading fzf
2015-03-11 06:07:34 +00:00
fzf is being actively developed and you might want to upgrade it once in a
while. Please follow the instruction below depending on the installation
2016-09-12 19:11:28 +00:00
method used.
2015-03-11 06:07:34 +00:00
- git: `cd ~/.fzf && git pull && ./install`
2015-11-03 18:13:22 +00:00
- brew: `brew update; brew reinstall fzf`
2015-03-11 06:07:34 +00:00
- vim-plug: `:PlugUpdate fzf`
2013-10-23 01:26:55 +00:00
Usage
-----
fzf will launch curses-based finder, read the list from STDIN, and write the
selected item to STDOUT.
```sh
find * -type f | fzf > selected
```
Without STDIN pipe, fzf will use find command to fetch the list of
2013-11-02 03:56:43 +00:00
files excluding hidden ones. (You can override the default command with
`FZF_DEFAULT_COMMAND`)
2013-10-23 01:26:55 +00:00
```sh
vim $(fzf)
2013-10-23 01:26:55 +00:00
```
2015-03-06 09:57:36 +00:00
#### Using the finder
2013-11-09 18:56:18 +00:00
2015-03-06 09:57:36 +00:00
- `CTRL-J` / `CTRL-K` (or `CTRL-N` / `CTRL-P)` to move cursor up and down
- `Enter` key to select the item, `CTRL-C` / `CTRL-G` / `ESC` to exit
- On multi-select mode (`-m`), `TAB` and `Shift-TAB` to mark multiple items
- Emacs style key bindings
- Mouse: scroll, click, double-click; shift-click and shift-scroll on
multi-select mode
#### Search syntax
Unless otherwise specified, fzf starts in "extended-search mode" where you can
type in multiple search terms delimited by spaces. e.g. `^music .mp3$ sbtrkt
!rmx`
| Token | Match type | Description |
| -------- | -------------------- | -------------------------------- |
| `sbtrkt` | fuzzy-match | Items that match `sbtrkt` |
| `^music` | prefix-exact-match | Items that start with `music` |
| `.mp3$` | suffix-exact-match | Items that end with `.mp3` |
| `'wild` | exact-match (quoted) | Items that include `wild` |
| `!rmx` | inverse-fuzzy-match | Items that do not match `rmx` |
| `!'fire` | inverse-exact-match | Items that do not include `fire` |
2015-09-12 04:31:07 +00:00
If you don't prefer fuzzy matching and do not wish to "quote" every word,
2015-11-03 13:49:32 +00:00
start fzf with `-e` or `--exact` option. Note that when `--exact` is set,
`'`-prefix "unquotes" the term.
2015-11-08 15:58:20 +00:00
A single bar character term acts as an OR operator. For example, the following
query matches entries that start with `core` and end with either `go`, `rb`,
or `py`.
```
^core go$ | rb$ | py$
```
2015-06-21 16:35:36 +00:00
#### Environment variables
- `FZF_DEFAULT_COMMAND`
- Default command to use when input is tty
2015-11-03 18:14:38 +00:00
- e.g. `export FZF_DEFAULT_COMMAND='ag -g ""'`
2015-06-21 16:35:36 +00:00
- `FZF_DEFAULT_OPTS`
2015-11-03 18:14:38 +00:00
- Default options
- e.g. `export FZF_DEFAULT_OPTS="--reverse --inline-info"`
2015-06-21 16:35:36 +00:00
2015-03-06 09:57:36 +00:00
Examples
--------
2013-10-23 01:26:55 +00:00
2015-03-06 09:57:36 +00:00
Many useful examples can be found on [the wiki
page](https://github.com/junegunn/fzf/wiki/examples). Feel free to add your
own as well.
2014-05-02 14:38:36 +00:00
2016-05-02 15:07:53 +00:00
`fzf-tmux` script
-----------------
[fzf-tmux](bin/fzf-tmux) is a bash script that opens fzf in a tmux pane.
```sh
# usage: fzf-tmux [-u|-d [HEIGHT[%]]] [-l|-r [WIDTH[%]]] [--] [FZF OPTIONS]
# (-[udlr]: up/down/left/right)
# select git branches in horizontal split below (15 lines)
git branch | fzf-tmux -d 15
# select multiple words in vertical split on the left (20% of screen width)
cat /usr/share/dict/words | fzf-tmux -l 20% --multi --reverse
```
It will still work even when you're not on tmux, silently ignoring `-[udlr]`
options, so you can invariably use `fzf-tmux` in your scripts.
2013-12-21 15:22:23 +00:00
Key bindings for command line
-----------------------------
The install script will setup the following key bindings for bash, zsh, and
fish.
- `CTRL-T` - Paste the selected files and directories onto the command line
- Set `FZF_CTRL_T_COMMAND` to override the default command
- Set `FZF_CTRL_T_OPTS` to pass additional options
- `CTRL-R` - Paste the selected command from history onto the command line
2015-04-11 15:44:41 +00:00
- Sort is disabled by default to respect chronological ordering
- Press `CTRL-R` again to toggle sort
- Set `FZF_CTRL_R_OPTS` to pass additional options
- `ALT-C` - cd into the selected directory
2016-05-02 15:07:53 +00:00
- Set `FZF_ALT_C_COMMAND` to override the default command
- Set `FZF_ALT_C_OPTS` to pass additional options
2013-11-08 16:16:39 +00:00
2015-04-21 17:07:27 +00:00
If you're on a tmux session, fzf will start in a split pane. You may disable
this tmux integration by setting `FZF_TMUX` to 0, or change the height of the
pane with `FZF_TMUX_HEIGHT` (e.g. `20`, `50%`).
If you use vi mode on bash, you need to add `set -o vi` *before* `source
~/.fzf.bash` in your .bashrc, so that it correctly sets up key bindings for vi
mode.
2015-05-09 11:15:14 +00:00
Fuzzy completion for bash and zsh
---------------------------------
#### Files and directories
2013-11-29 08:49:48 +00:00
Fuzzy completion for files and directories can be triggered if the word before
the cursor ends with the trigger sequence which is by default `**`.
- `COMMAND [DIRECTORY/][FUZZY_PATTERN]**<TAB>`
```sh
2013-11-19 16:42:57 +00:00
# Files under current directory
# - You can select multiple items with TAB key
vim **<TAB>
2013-11-19 16:42:57 +00:00
# Files under parent directory
vim ../**<TAB>
# Files under parent directory that match `fzf`
vim ../fzf**<TAB>
2013-11-19 16:42:57 +00:00
# Files under your home directory
vim ~/**<TAB>
2013-11-19 16:42:57 +00:00
# Directories under current directory (single-selection)
cd **<TAB>
2013-11-19 16:42:57 +00:00
# Directories under ~/github that match `fzf`
cd ~/github/fzf**<TAB>
```
#### Process IDs
Fuzzy completion for PIDs is provided for kill command. In this case
2013-11-29 08:49:48 +00:00
there is no trigger sequence, just press tab key after kill command.
```sh
# Can select multiple processes with <TAB> or <Shift-TAB> keys
kill -9 <TAB>
```
#### Host names
2013-11-29 09:09:51 +00:00
For ssh and telnet commands, fuzzy completion for host names is provided. The
names are extracted from /etc/hosts and ~/.ssh/config.
```sh
ssh **<TAB>
telnet **<TAB>
```
#### Environment variables / Aliases
```sh
unset **<TAB>
export **<TAB>
unalias **<TAB>
```
2013-11-19 16:42:57 +00:00
#### Settings
```sh
2013-11-19 16:42:57 +00:00
# Use ~~ as the trigger sequence instead of the default **
export FZF_COMPLETION_TRIGGER='~~'
2013-11-19 16:42:57 +00:00
# Options to fzf command
export FZF_COMPLETION_OPTS='+c -x'
# Use ag instead of the default find command for listing candidates.
# - The first argument to the function is the base path to start traversal
# - Note that ag only lists files not directories
# - See the source code (completion.{bash,zsh}) for the details.
2016-01-19 16:39:55 +00:00
_fzf_compgen_path() {
ag -g "" "$1"
}
```
#### Supported commands
On bash, fuzzy completion is enabled only for a predefined set of commands
(`complete | grep _fzf` to see the list). But you can enable it for other
commands as well like follows.
```sh
# There are also _fzf_path_completion and _fzf_dir_completion
complete -F _fzf_file_completion -o default -o bashdefault doge
```
2014-01-07 08:07:02 +00:00
Usage as Vim plugin
-------------------
2015-08-22 10:30:21 +00:00
This repository only enables basic integration with Vim. If you're looking for
more, check out [fzf.vim](https://github.com/junegunn/fzf.vim) project.
(Note: To use fzf in GVim, an external terminal emulator is required.)
2014-03-25 10:55:52 +00:00
2015-03-06 09:57:36 +00:00
#### `:FZF[!]`
2014-03-27 15:58:07 +00:00
If you have set up fzf for Vim, `:FZF` command will be added.
2014-01-07 08:07:02 +00:00
```vim
" Look for files under current directory
:FZF
" Look for files under your home directory
:FZF ~
" With options
:FZF --no-sort -m /tmp
" Bang version starts in fullscreen instead of using tmux pane or Neovim split
:FZF!
2014-01-07 08:07:02 +00:00
```
Similarly to [ctrlp.vim](https://github.com/kien/ctrlp.vim), use enter key,
`CTRL-T`, `CTRL-X` or `CTRL-V` to open selected files in the current window,
in new tabs, in horizontal splits, or in vertical splits respectively.
Note that the environment variables `FZF_DEFAULT_COMMAND` and
2015-04-21 17:07:27 +00:00
`FZF_DEFAULT_OPTS` also apply here. Refer to [the wiki page][fzf-config] for
2015-04-15 13:52:15 +00:00
customization.
2015-04-21 17:07:27 +00:00
[fzf-config]: https://github.com/junegunn/fzf/wiki/Configuring-FZF-command-(vim)
#### `fzf#run`
2014-03-25 10:55:52 +00:00
For more advanced uses, you can use `fzf#run([options])` function with the
following options.
2014-03-25 10:55:52 +00:00
| Option name | Type | Description |
| -------------------------- | ------------- | ---------------------------------------------------------------- |
| `source` | string | External command to generate input to fzf (e.g. `find .`) |
| `source` | list | Vim list as input to fzf |
| `sink` | string | Vim command to handle the selected item (e.g. `e`, `tabe`) |
| `sink` | funcref | Reference to function to process each selected item |
| `sink*` | funcref | Similar to `sink`, but takes the list of output lines at once |
| `options` | string | Options to fzf |
| `dir` | string | Working directory |
| `up`/`down`/`left`/`right` | number/string | Use tmux pane with the given size (e.g. `20`, `50%`) |
| `window` (*Neovim only*) | string | Command to open fzf window (e.g. `vertical aboveleft 30new`) |
| `launcher` | string | External terminal emulator to start fzf with (GVim only) |
| `launcher` | funcref | Function for generating `launcher` string (GVim only) |
2014-03-25 10:55:52 +00:00
2015-08-15 17:47:52 +00:00
Examples can be found on [the wiki
2015-03-06 09:57:36 +00:00
page](https://github.com/junegunn/fzf/wiki/Examples-(vim)).
#### `fzf#wrap`
`fzf#wrap([name string,] [opts dict,] [fullscreen boolean])` is a helper
function that decorates the options dictionary so that it understands
`g:fzf_layout`, `g:fzf_action`, and `g:fzf_history_dir` like `:FZF`.
```vim
command! -bang MyStuff
\ call fzf#run(fzf#wrap('my-stuff', {'dir': '~/my-stuff'}, <bang>0))
```
2013-11-10 10:51:32 +00:00
Tips
----
2015-03-06 09:57:36 +00:00
#### Rendering issues
2014-03-09 01:43:59 +00:00
2016-03-28 12:40:28 +00:00
If you have any rendering issues, check the following:
2014-03-09 01:43:59 +00:00
1. Make sure `$TERM` is correctly set. fzf will use 256-color only if it
2015-04-21 17:07:27 +00:00
contains `256` (e.g. `xterm-256color`)
2014-03-09 02:52:35 +00:00
2. If you're on screen or tmux, `$TERM` should be either `screen` or
2015-04-21 17:07:27 +00:00
`screen-256color`
2014-03-09 01:43:59 +00:00
3. Some terminal emulators (e.g. mintty) have problem displaying default
2015-04-21 17:07:27 +00:00
background color and make some text unable to read. In that case, try
`--black` option. And if it solves your problem, I recommend including it
in `FZF_DEFAULT_OPTS` for further convenience.
2014-03-09 01:43:59 +00:00
4. If you still have problem, try `--no-256` option or even `--no-color`.
2013-12-21 15:22:23 +00:00
2015-03-06 09:57:36 +00:00
#### Respecting `.gitignore`, `.hgignore`, and `svn:ignore`
2014-04-06 06:25:58 +00:00
[ag](https://github.com/ggreer/the_silver_searcher) or
[pt](https://github.com/monochromegane/the_platinum_searcher) will do the
filtering:
```sh
# Feed the output of ag into fzf
2015-11-03 18:14:38 +00:00
ag -g "" | fzf
2014-04-06 06:25:58 +00:00
# Setting ag as the default source for fzf
2015-11-03 18:14:38 +00:00
export FZF_DEFAULT_COMMAND='ag -g ""'
2014-04-06 06:25:58 +00:00
# Now fzf (w/o pipe) will use ag instead of find
fzf
# To apply the command to CTRL-T as well
export FZF_CTRL_T_COMMAND="$FZF_DEFAULT_COMMAND"
2014-04-06 06:25:58 +00:00
```
2016-09-12 19:11:28 +00:00
If you don't want to exclude hidden files, use the following command:
```sh
export FZF_DEFAULT_COMMAND='ag --hidden --ignore .git -g ""'
```
2015-03-06 09:57:36 +00:00
#### `git ls-tree` for fast traversal
2014-05-02 03:52:06 +00:00
If you're running fzf in a large git repository, `git ls-tree` can boost up the
speed of the traversal.
```sh
export FZF_DEFAULT_COMMAND='
(git ls-tree -r --name-only HEAD ||
find . -path "*/\.*" -prune -o -type f -print -o -type l -print |
sed s/^..//) 2> /dev/null'
2014-05-02 03:52:06 +00:00
```
2015-03-06 09:57:36 +00:00
#### Fish shell
It's [a known bug of fish](https://github.com/fish-shell/fish-shell/issues/1362)
that it doesn't allow reading from STDIN in command substitution, which means
simple `vim (fzf)` won't work as expected. The workaround is to store the result
of fzf to a temporary file.
```sh
2015-04-21 17:07:27 +00:00
fzf > $TMPDIR/fzf.result; and vim (cat $TMPDIR/fzf.result)
```
2013-10-23 01:26:55 +00:00
License
-------
[MIT](LICENSE)
2013-10-23 01:26:55 +00:00
Author
------
Junegunn Choi