{"id":45385215,"url":"https://github.com/the0807/ff","last_synced_at":"2026-02-21T17:26:52.735Z","repository":{"id":330571712,"uuid":"1123206783","full_name":"the0807/ff","owner":"the0807","description":"🔍 An interactive file search and navigation tool using fzf","archived":false,"fork":false,"pushed_at":"2026-02-10T03:07:47.000Z","size":16200,"stargazers_count":40,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-10T06:53:16.324Z","etag":null,"topics":["cli","developer-tools","fd","file-finder","fuzzy-finder","fzf","ripgrep","search-tool","shell-script","terminal"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/the0807.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-26T11:50:36.000Z","updated_at":"2026-02-10T03:07:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/the0807/ff","commit_stats":null,"previous_names":["the0807/ff"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/the0807/ff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the0807%2Fff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the0807%2Fff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the0807%2Fff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the0807%2Fff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/the0807","download_url":"https://codeload.github.com/the0807/ff/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the0807%2Fff/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29688232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T15:51:39.154Z","status":"ssl_error","status_checked_at":"2026-02-21T15:49:03.425Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","developer-tools","fd","file-finder","fuzzy-finder","fzf","ripgrep","search-tool","shell-script","terminal"],"created_at":"2026-02-21T17:26:52.164Z","updated_at":"2026-02-21T17:26:52.726Z","avatar_url":"https://github.com/the0807.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔍 ff - Flexible File Finder\n\n[![CI](https://github.com/the0807/ff/actions/workflows/test.yml/badge.svg)](https://github.com/the0807/ff/actions/workflows/test.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nA powerful interactive file search and navigation tool using `fzf`. Seamlessly switch between file finding (by name) and content searching (by text) modes for fast and intuitive file exploration and editing.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cb\u003eFind Mode\u003c/b\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cb\u003eGrep Mode\u003c/b\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"assets/find.gif\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"assets/grep.gif\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cb\u003eChange directory\u003c/b\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cb\u003eOpen file\u003c/b\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"assets/cd.gif\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"assets/open.gif\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## ✨ Features\n\n- 🔄 **Dual Mode Operation**: Instantly switch between Find mode and Grep mode with a single `TAB` keypress\n- 👀 **Live Preview**: Real-time file content preview with syntax highlighting\n- 🎨 **Syntax Highlighting**: Beautiful code display using `bat`/`batcat`\n- 🌳 **Directory Trees**: Visual directory structure using `eza` or `tree`\n- ⚡ **Lightning Fast**: High-speed searching with `fd` and `ripgrep`\n- 📝 **Editor Integration**: Direct file opening in VSCode or your preferred editor\n- 🎯 **Jump to Line**: Navigate directly to matched lines in Grep mode\n- 🔧 **Smart Fallbacks**: Works with standard Unix tools when optional dependencies aren't available\n- 🎨 **Beautiful UI**: Polished interface with icons, colors, and intuitive controls\n\n## 📋 Requirements\n\n### Required\n- **`fzf`** - Interactive fuzzy finder (core dependency)\n- **Supported Shells**: Bash, Zsh, Fish\n\n### Optional (Highly Recommended)\nInstall these for the best experience:\n\n| Tool              | Purpose                           | Fallback                |\n| ----------------- | --------------------------------- | ----------------------- |\n| `fd`              | Fast file finder                  | `find`                  |\n| `ripgrep` (rg)    | Lightning-fast content search     | `grep`                  |\n| `bat` or `batcat` | Syntax-highlighted previews       | `cat`                   |\n| `eza`             | Modern directory trees            | `tree` or basic display |\n| `tree`            | Directory structure visualization | Basic display           |\n\n\u003e **Note:** To see icons in directory trees when using `eza`, you need to install a [Nerd Font](https://www.nerdfonts.com/). Popular choices include:\n\u003e - [JetBrains Mono Nerd Font](https://www.nerdfonts.com/font-downloads)\n\u003e - [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)\n\u003e - [Hack Nerd Font](https://www.nerdfonts.com/font-downloads)\n\u003e\n\u003e After installation, configure your terminal to use the Nerd Font.\n\n## 📦 Installing Dependencies\n\n### macOS (Homebrew)\n```bash\nbrew install fzf fd ripgrep bat eza tree\n```\n\n### Ubuntu/Debian\n```bash\nsudo apt update\nsudo apt install fzf fd-find ripgrep bat eza tree\n```\n\n## 🚀 Installation\n\n### Method 1: Quick Install (Recommended)\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/the0807/ff/main/install.sh | bash\n```\n\nThen reload your shell:\n```bash\nsource ~/.zshrc          # for zsh users\nsource ~/.bashrc         # for bash users\nsource ~/.config/fish/config.fish  # for fish users\n```\n\n### Method 2: Manual Install\n\n1. **Download the script:**\n\n**For Bash/Zsh:**\n```bash\nmkdir -p ~/.config/ff\ncurl -fsSL https://raw.githubusercontent.com/the0807/ff/main/ff.sh -o ~/.config/ff/ff.sh\n```\n\n**For Fish:**\n```bash\nmkdir -p ~/.config/ff\ncurl -fsSL https://raw.githubusercontent.com/the0807/ff/main/ff.fish -o ~/.config/ff/ff.fish\n```\n\n2. **Add to your shell configuration:**\n\n**For Zsh** (`~/.zshrc`):\n```bash\necho 'source ~/.config/ff/ff.sh' \u003e\u003e ~/.zshrc\nsource ~/.zshrc\n```\n\n**For Bash** (`~/.bashrc` or `~/.bash_profile` on macOS):\n```bash\necho 'source ~/.config/ff/ff.sh' \u003e\u003e ~/.bashrc\nsource ~/.bashrc\n```\n\n**For Fish** (`~/.config/fish/config.fish`):\n```fish\necho 'source ~/.config/ff/ff.fish' \u003e\u003e ~/.config/fish/config.fish\nsource ~/.config/fish/config.fish\n```\n\n## 🗑️ Uninstallation\n\nIf you installed ff using the quick install method, the uninstaller is already available locally:\n\n```bash\nbash ~/.config/ff/uninstall.sh\n```\n\nIf the local uninstaller is not available, you can download it:\n\n```bash\n# Download and run the uninstaller\ncurl -fsSL https://raw.githubusercontent.com/the0807/ff/main/uninstall.sh -o /tmp/uninstall-ff.sh\nbash /tmp/uninstall-ff.sh\n```\n\nThe uninstaller will:\n- Remove `~/.config/ff/` directory\n- Clean up shell configuration files (`.zshrc`, `.bashrc`, `config.fish`)\n- Create backups before modifying any files\n\n## 📖 Usage\n\n### Basic Commands\n\n```bash\nff          # Start in Find mode (default)\nff find     # Start in Find mode (explicit)\nff grep     # Start in Grep mode\n```\n\n### Key Bindings\n\n#### Common Controls\n| Key      | Action                                             |\n| -------- | -------------------------------------------------- |\n| `Enter`  | Navigate to file/directory                         |\n| `Ctrl-O` | Open file in editor (at matched line in Grep mode) |\n| `TAB`    | Toggle between Find and Grep mode                  |\n| `Ctrl-U` | Scroll preview up                                  |\n| `Ctrl-D` | Scroll preview down                                |\n| `Esc`    | Exit                                               |\n| `Ctrl-C` | Cancel/Exit                                        |\n\n#### Find Mode\n- Type to fuzzy search by **filename**\n- Press `Enter` to navigate to the selected file's directory\n- Press `Ctrl-O` to open the file in your editor\n\n#### Grep Mode\n- Type to search by **file content**\n- See matching files with line numbers and context\n- Press `Enter` to navigate to the file's directory\n- Press `Ctrl-O` to open the file at the matched line\n\n## 🎨 Usage Examples\n\n### Example 1: Quick File Search\n```bash\n$ ff\n# Type \"config\" to fuzzy find files matching \"config\"\n# Use arrow keys to select\n# Press Enter to cd to the file's directory\n# Or press Ctrl-O to open the file\n```\n\n### Example 2: Search Code Content\n```bash\n$ ff grep\n# Type \"function handleClick\"\n# See all files containing this text\n# Files show with line numbers highlighted\n# Press Ctrl-O to open in editor at that exact line\n```\n\n### Example 3: Dynamic Mode Switching\n```bash\n$ ff\n# Start browsing files in Find mode\n# Type \"README\" to find README files\n# Press TAB to switch to Grep mode\n# Type \"installation\" to search content\n# Press TAB again to return to Find mode\n```\n\n### Example 4: Navigation Workflow\n```bash\n$ ff find\n# Search for \"utils.js\"\n# Press Enter to cd to the directory\n$ pwd  # You're now in the file's directory\n```\n\n## ⚙️ Customization\n\n### Change Default Editor\n\nBy default, `ff` uses VSCode (`code`) if available, otherwise falls back to `$EDITOR`. To customize:\n\n```bash\n# Add to ~/.zshrc or ~/.bashrc\nexport EDITOR=nvim     # Neovim\n# or\nexport EDITOR=vim      # Vim\n# or\nexport EDITOR=nano     # Nano\n```\n\n### Modify Search Behavior\n\nEdit the `ff.sh` file to customize:\n- FZF options (layout, theme, colors)\n- Preview window size and position\n- Key bindings\n- Search commands\n\n## 🎯 How It Works\n\n### Find Mode\n1. Uses `fd` (or `find`) to list all files and directories\n2. Pipes results to `fzf` for interactive filtering\n3. Shows file previews using `bat` (with syntax highlighting)\n4. Shows directory trees using `eza` or `tree`\n\n### Grep Mode\n1. Uses `ripgrep` (or `grep`) to search file contents as you type\n2. Results show filename, line number, and matched content\n3. Preview highlights the matched line in context\n4. Opening with `Ctrl-O` jumps directly to the matched line\n\n## 🔧 Troubleshooting\n\n### \"fzf not found\" error\n```bash\n# Check if fzf is installed\nwhich fzf\n\n# If not installed, install it:\n# macOS\nbrew install fzf\n\n# Ubuntu/Debian\nsudo apt install fzf\n```\n\n### Preview not displaying properly\nInstall the optional tools for better previews:\n```bash\n# macOS\nbrew install bat eza tree\n\n# Ubuntu/Debian\nsudo apt install bat eza tree\n```\n\n### Editor not opening files\nCheck your `EDITOR` environment variable:\n```bash\necho $EDITOR\n\n# If empty or not your preferred editor, set it:\nexport EDITOR=vim  # or your preferred editor\n```\n\n### VSCode not opening at the correct line\nEnsure VSCode command-line tools are installed:\n1. Open VSCode\n2. Press `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Linux/Windows)\n3. Type \"Shell Command: Install 'code' command in PATH\"\n4. Select it and restart your terminal\n\n## 🤝 Contributing\n\nContributions are welcome! Feel free to:\n- 🐛 Report bugs by opening an issue\n- 💡 Suggest new features\n- 🔧 Submit pull requests\n- 📖 Improve documentation\n\n## 📄 License\n\nMIT License - Feel free to use, modify, and distribute.\n\n## 🙏 Acknowledgments\n\nThis project is built on top of these excellent tools:\n- [fzf](https://github.com/junegunn/fzf) - Command-line fuzzy finder\n- [fd](https://github.com/sharkdp/fd) - Fast and user-friendly alternative to find\n- [ripgrep](https://github.com/BurntSushi/ripgrep) - Recursively search directories for regex patterns\n- [bat](https://github.com/sharkdp/bat) - Cat clone with syntax highlighting\n- [eza](https://github.com/eza-community/eza) - Modern replacement for ls\n\n## 💡 Tips \u0026 Tricks\n\n### Tip 1: Quick Project Navigation\n```bash\n# From anywhere in your project\nff\n# Type the filename you want to work on\n# Press Enter to navigate there\n# Your shell is now in that directory!\n```\n\n### Tip 2: Finding TODO Comments\n```bash\nff grep\n# Type \"TODO\"\n# See all TODO comments across your codebase\n# Press Ctrl-O to open and fix them\n```\n\n### Tip 3: Configuration File Hunting\n```bash\nff\n# Type \"config\"\n# Quickly find all configuration files\n```\n\n### Tip 4: Searching for Functions\n```bash\nff grep\n# Type \"function myFunction\"\n# Find where functions are defined\n# Jump directly to the definition\n```\n\n## 📊 Performance\n\n`ff` is designed to be fast even in large codebases:\n- With `fd` and `ripgrep`: Handles repositories with 100,000+ files efficiently\n- Real-time search results as you type\n- Minimal memory footprint\n- Works great on both small and large projects\n\n---\n\n**Happy file browsing! 🚀**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe0807%2Fff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe0807%2Fff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe0807%2Fff/lists"}