https://github.com/scaryrawr/fzf.zsh

fzf plugin for zsh based on PatrickF1/fzf.fish
https://github.com/scaryrawr/fzf.zsh

fzf fzf-plugin zsh-plugin

Last synced: 3 months ago
JSON representation

fzf plugin for zsh based on PatrickF1/fzf.fish

• Host: GitHub
• URL: https://github.com/scaryrawr/fzf.zsh
• Owner: scaryrawr
• Created: 2025-01-15T15:56:17.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-02-19T20:47:07.000Z (4 months ago)
• Last Synced: 2025-02-19T21:31:22.001Z (4 months ago)
• Topics: fzf, fzf-plugin, zsh-plugin
• Language: Shell
• Homepage:
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FZF ZSH Plugin

This is a plugin for zsh heavily inspired by [PatrickF1/fzf.fish](https://github.com/PatrickF1/fzf.fish).

It's still a work in progress, and has slightly different keybindings.

## Keybindings

| Keybinding                   | Description                            |

| ---------------------------- | -------------------------------------- |

| `Ctrl+T` or `Ctrl+Alt+F`     | File search using fzf                  |

| `Ctrl+R`                     | History search using fzf               |

| `Alt+c`                      | Change directory using fzf             |

| `Ctrl+Alt+L`                 | Git log search using fzf               |

| `Ctrl+Alt+T` or `Ctrl+Alt+S` | Git status search using fzf            |

| `Ctrl+V`                     | Environment variables search using fzf |

| `Ctrl+Alt+P`                 | Find a package name using fzf          |

| `Ctrl+Alt+B`                 | Blame search                           |

## Installation

### Antidote

```sh

antidote install scaryrawr/fzf.zsh

```

### Oh My Zsh

```sh

git clone https://github.com/scaryrawr/fzf.zsh $ZSH_CUSTOM/plugins/fzf

```

## Screenshots

### File Search

![File Search](assets/file_search.png)

![Image Preview](assets/image_preview.png)

### History Search

![History Search](assets/history_search.png)

### Change Directory

![Change Directory](assets/change_directory.png)

### Git Log Search

![Git Log Search](assets/git_log_search.png)

### Git Status Search

![Git Status Search](assets/git_status_search.png)

### Environment Variables Search

![Environment Variables Search](assets/env_vars_search.png)

### Find a Package Name

![Find a Package Name](assets/find_package_name.png)

## Dependencies

### Required

- [fzf](https://github.com/junegunn/fzf)

### Optional

- [chafa](https://github.com/hpjansson/chafa) - Image preview

- [bat](https://github.com/sharkdp/bat) - cat with syntax highlighting

- [fd](https://github.com/sharkdp/fd) - Alternative to `find`

- [eza](https://github.com/eza-community/eza) - Alternative to `ls`

## Customizable Variables

You can customize the behavior of the fzf plugin by setting the following environment variables:

| Variable Name                | Description                           | Passed Argument |

| ---------------------------- | ------------------------------------- | --------------- |

| `FZF_DEFAULT_OPTS`           | Default options for fzf               | N/A             |

| `FZF_PREVIEW_CMD`            | Command to use for file preview       | file path       |

| `FZF_GIT_BLAME_PREVIEW_CMD`  | Command to use for git blame preview  | file path       |

| `FZF_GIT_COMMIT_PREVIEW_CMD` | Command to use for git commit preview | commit          |

| `FZF_GIT_LOG_PREVIEW_CMD`    | Command to use for git log preview    | commit          |

| `FZF_DIFF_PREVIEW_CMD`       | Command to use for diff preview       | diff            |