fif

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #go #android #deep-learning #docker #awesome #cli #kubernetes #awesome-list #openai #mcp

(★ 11)

🔍 Quickly find in files using fuzzy search and surrounding context

fif Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

fif is a shell utility to quickly find text in files using fuzzy
 searching, and a syntax highlighted preview with a surrounding
 context.

## Requirements

[fzf](https://github.com/junegunn/fzf) version
[0.18.0](https://github.com/junegunn/fzf/releases/tag/0.18.0) or above.

### Optional

#### Concatenation

For file concatenation either
[rg](https://github.com/BurntSushi/ripgrep) or
[ag](https://github.com/ggreer/the_silver_searcher) is optionally
required, and fif will fall back to `grep` if none of those are present. I
recommend using [rg](https://github.com/BurntSushi/ripgrep) or
[ag](https://github.com/ggreer/the_silver_searcher) since those two
respect things like git ignore and hidden files. Most options passed to
these tools are configurable. [More on that below](#configuration).

#### Preview

[bat](https://github.com/sharkdp/bat) version
[0.10.0](https://github.com/sharkdp/bat/releases/tag/v0.10.0) or above
is optionally required to syntax highlight the preview window, if
`bat` isn't present `fif` will fall back to
[highlight](http://www.andre-simon.de/doku/highlight/highlight.php),
then [python-pygments](https://pygments.org/), and lastly `cat` with
no colors other than the highlighted line (inverted). I warmly
recommend `bat`, as its fast and does a good job highlighting

## Installation

### ZSH Plugin manager

#### [zplug](https://github.com/zplug/zplug)

```bash
zplug 'roosta/fif'
```

#### [zgen](https://github.com/tarjoilija/zgen)

```bash
zgen load 'roosta/fif'
```

#### [Antigen](https://github.com/zsh-users/antigen)

```bash
antigen bundle 'roosta/fif'
```

### Manual installation

Clone this repository somewhere and source `fif.plugin.zsh` or
`fif.plugin.sh` in your shell config.

## Demonstration

## Usage

```
fif [FILE|PATH]
```

Running `fif` with no arguments will start fuzzy matching lines in all
files from `pwd`.

fif optionally accept a path or file as an argument and will limit search to
that scope.

``` bash
fif ~/some-file.txt
```

## Configuration

### Default keybinds

| keybind | action |
 | --------- | -------------------------------- |
 | <kbd>Enter</kbd> | Confirm and open file location |
 | <kbd>Ctrl-s</kbd> | Toggle sort |
 | <kbd>Ctrl-p</kbd> | Toggle preview |

### Options

To use these options export environment variables and source fif.plugin.zsh

<details> <summary><code>FIF_ALIAS</code></summary>
Change the command name of fif via this environment variable.

```bash
export FIF_ALIAS="my-alias"
source ~/fif-location/fif.plugin.zsh
my-alias ~/file.txt
```
</details>

<details>
<summary><code>FIF_EDITOR_SCRIPT</code></summary>

By default fif tries to use `$EDITOR` (see
[editor.sh](https://github.com/roosta/fif/blob/master/editor.sh)) to
open a given file, but since different editors have different syntax,
this variable exist to help setting up a custom editor. fif works out
of the box with Vim and Emacs but say I wanted to use visual studio
code:

First create a script file that takes two arguments. The first
argument is the line number of the selected match, the second is the
file that is to be opened.

So a custom editor script for visual studio code would look like this:

```bash
code --goto "${2}:${1}"
```

Save the file somewhere and point the `FIF_EDITOR_SCRIPT` variable to said file.

```bash
export FIF_EDITOR_SCRIPT="~/my-editor-script.sh"
```

Remember to set execute permissions for the script.

</details>

Environment that contains the default options when using `fzf` via
`fif`. Default is:
```bash
export FIF_FZF_OPTS="
--ansi
--bind='ctrl-s:toggle-sort'
--bind='ctrl-p:toggle-preview'
--preview-window=up
"
```
in combination with what's defined in `FZF_DEFAULT_OPTS`. (No need to
repeat the options already defined in FZF_DEFAULT_OPTS)
</details>

<details>
<summary><code>FIF_GREP_OPTS</code></summary>
Options passed to `grep`. Can be set as a zsh array (preferred) or a plain string. Default is:

```zsh
# Preferred: native zsh array, set before sourcing fif
fif_grep_opts=(
  --color=always
  --exclude-dir={.git,.svn,CVS}
)

# Alternative: string, split by whitespace
export FIF_GREP_OPTS="--color=always --exclude-dir={.git,.svn,CVS}"
```

> **Note:** Options containing embedded spaces must use the zsh array form.
</details>

<details>
<summary><code>FIF_GREP_COLORS</code></summary>
Colors used with grep, default is:

```bash
export FIF_GREP_COLORS="mt=97:ln=33:fn=34:se=37"
```
This will color filenames(fn) with blue, line number(ln) as yellow,
line contents(mt) as bright white, and separators(se) as white

Check out the Environment section in the grep manual for an overview.
</details>

<details>
<summary><code>FIF_RG_OPTS</code></summary>
Options passed to `rg`. Can be set as a zsh array (preferred) or a plain string. Default is:

```zsh
# Preferred: native zsh array, set before sourcing fif
fif_rg_opts=(
  --hidden
  --color always
  --colors=match:none
  --colors=path:fg:blue
  --colors=line:fg:yellow
)

# Alternative: string, split by whitespace
export FIF_RG_OPTS="--hidden --color always --colors=match:none --colors=path:fg:blue --colors=line:fg:yellow"
```

> **Note:** Options containing embedded spaces must use the zsh array form.
</details>

<details>
<summary><code>FIF_AG_OPTS</code></summary>
Options passed to `ag`. Can be set as a zsh array (preferred) or a plain string. Default is:

```zsh
# Preferred: native zsh array, set before sourcing fif
fif_ag_opts=(
  --hidden
  --color
  --color-path 34
  --color-match 97
  --color-line-number 33
)

# Alternative: string, split by whitespace
export FIF_AG_OPTS="--hidden --color --color-path 34 --color-match 97 --color-line-number 33"
```

Colors used are blue for path, bright white for match, and yellow line number.

> **Note:** Options containing embedded spaces must use the zsh array form.
</details>

## Attribution

### [Forgit](https://github.com/wfxr/forgit)

Used as an example on how to do zsh plugins and how to handle
options. Also took some pointer from its
[README](https://github.com/wfxr/forgit/blob/master/README.md).

### [Enhancd](https://github.com/b4b4r07/enhancd)
Used for reference, and pointers

fif

fif Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fif

fif Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README