2018-09-22 10:59:28 +00:00
# fzf.kak
2018-09-22 11:15:53 +00:00
**fzf.kak** is a plugin for Kakoune editor, that brings integration with fzf
tool. This plugin is being tested against Kakoune 2018.09.04.
2018-09-24 08:54:05 +00:00
### Dependencies
2018-09-24 12:17:52 +00:00
|Tool |Information |
|:--------:|:------------------------------------------------------------------------------------------------------|
|tmux |This plugin depends on [fzf-tmux ](https://github.com/junegunn/fzf/blob/master/bin/fzf-tmux ) script. |
|X11 |Script should work with X11 via `termcmd` option. |
|GNU Screen|GNU Screen is not yet supported. |
2018-09-24 08:54:05 +00:00
2018-09-22 11:15:53 +00:00
## Installation
2018-09-24 08:54:05 +00:00
Recommended way to install is to use [plug.kak ](https://github.com/andreyorst/plug.kak ) plugin
manager. You can install **fzf.kak** by adding this to your `kakrc` :
2018-09-22 11:15:53 +00:00
```kak
plug andreyorst/fzf.kak
```
2018-09-24 08:54:05 +00:00
Then reload Kakoune config or restart Kakoune and run `:plug-install` .
Or install this plugin any other preferred way.
2018-09-22 11:15:53 +00:00
## Usage
2018-09-22 17:25:20 +00:00
**fzf.kak** doesn't provide any mapping by default. Instead there's now a `fzf-mode` command
which intentionally was made to simplify user mappings.
Each fzf command has mnemonic mapping, like `f` for opening files, `t` for tags and so on.
2018-09-22 11:15:53 +00:00
In this mode new mappings are available:
- < kbd > f</ kbd > - Search for file and open it
- < kbd > b</ kbd > - Select buffer
- < kbd > t</ kbd > - Browse ctags tags
- < kbd > g</ kbd > - Edit file in Git tree
2018-09-22 17:25:20 +00:00
You can set your own mapping to invoke `fzf-mode` :
```
map global normal < c-p > ': fzf-mode< ret > '
# note that the space after colon is intentional to suppess fzf-mode to show in command history
```
2018-09-22 11:15:53 +00:00
So for example pressing < kbd > Ctrl+p< / kbd > < kbd > f< / kbd > will open fzf at the
bottom of the Kakoune buffer, showing you all possible files.
2018-09-22 17:25:20 +00:00
### Settings
2018-09-24 12:05:48 +00:00
#### Files
2018-09-22 17:25:20 +00:00
You can configure what command to use to search for files, and it's arguments.
Supported tools are [GNU Find ](https://www.gnu.org/software/findutils/ ), [The Silver Searcher ](https://github.com/ggreer/the_silver_searcher ), [ripgrep ](https://github.com/BurntSushi/ripgrep ). GNU find is used by default, but you can switch to another one. There are some default values for those, so you can go:
```kak
set-option global fzf_file_command 'rg' # 'ag' or 'find'
```
Or if you don't like default file arguments, which are `find -type f` , and would like to disable searching in, say `.git` directories you can set it like so:
```kak
set-option global fzf_file_command "find . \( -path '*/.svn*' -o -path '*/.git*' \) -prune -o -type f -print"
```
2018-09-24 12:05:48 +00:00
The same pattern applies for other commands, except `buffer` , and `cd` .
#### Git
You also able to set what git command to use to provide git-tree. These are default argumens:
```kak
set-option global fzf_git_command 'git ls-tree --name-only -r HEAD'
```
Other VCS are not supported officially, but might work.
#### ctags
It is also possible to add parametees to ctags search executable:
```kak
set-option global fzf_tag_command 'readtags -l | cut -f1 | sort -u | ... '
```
#### Misc
**fzf.kak** relies on tmp folder to work with all possible environments, however not every system features
the same path to `tmp` . You can set different path to your or to any other directory with:
2018-09-22 17:25:20 +00:00
```kak
set-option global fzf_tmp //path/to/tmp'
```
2018-09-24 12:05:48 +00:00
2018-09-22 13:36:29 +00:00
## Some demonstration gifs:
### Opening files:
### Searching tags with universal-ctags
### Browsing Git tree files
### Switching buffers
### Changing directories
2018-09-22 17:25:20 +00:00
## Special thanks
Original script, that current implementation is based on, was implemented by [topisani ](https://github.com/topisani ). If you are here, thank you for your work, it is awesome!
