{"id":28700483,"url":"https://github.com/niksingh710/fzf-preview","last_synced_at":"2025-06-14T11:07:58.449Z","repository":{"id":271941792,"uuid":"915048009","full_name":"niksingh710/fzf-preview","owner":"niksingh710","description":"A Simple Fzf Preview Script, helps to preview any filetype in fzf preview window.","archived":false,"fork":false,"pushed_at":"2025-06-03T09:57:11.000Z","size":24,"stargazers_count":25,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T20:53:03.786Z","etag":null,"topics":["bash-script","finder","fuzzy","fzf","fzf-preview","fzf-preview-pane","image-preview","information","preview","terminal"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/niksingh710.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}},"created_at":"2025-01-10T21:15:35.000Z","updated_at":"2025-06-03T09:57:12.000Z","dependencies_parsed_at":"2025-01-10T22:37:07.472Z","dependency_job_id":"9842bcba-6374-4055-b24c-3451f5b09de9","html_url":"https://github.com/niksingh710/fzf-preview","commit_stats":null,"previous_names":["niksingh710/fzf-preview"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/niksingh710/fzf-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niksingh710%2Ffzf-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niksingh710%2Ffzf-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niksingh710%2Ffzf-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niksingh710%2Ffzf-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/niksingh710","download_url":"https://codeload.github.com/niksingh710/fzf-preview/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niksingh710%2Ffzf-preview/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259804866,"owners_count":22913903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bash-script","finder","fuzzy","fzf","fzf-preview","fzf-preview-pane","image-preview","information","preview","terminal"],"created_at":"2025-06-14T11:07:57.958Z","updated_at":"2025-06-14T11:07:58.441Z","avatar_url":"https://github.com/niksingh710.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# 🚀 **fzf-preview**: A Simple and Versatile FZF Preview Script\n\n`fzf-preview` is a lightweight and easy-to-understand script designed to enhance your `fzf` workflow with powerful previews. Whether you're working with symlinks pointing to the Nix store or need to preview different file formats, this script has you covered!\n\n![output](https://github.com/user-attachments/assets/c5f5b892-1794-4efd-9254-fe6569e918ea)\n\n---\n\n### ✨ **Features**\n\n- 🔗 **Symlink Support:** Preview files even if they are symlinks pointing to the Nix store.\n- 🖼️ **Image Previews:** Supports sixel and symbolic image previews. Customize the image handler with the `FZF_PREVIEW_IMAGE_HANDLER` environment variable.\n- 🎥 **Video \u0026 PDF Previews:** Display video thumbnails and PDF front pages easily.\n- 📂 **Archive Support:** View contents of compressed files (e.g., zip, tar, etc.).\n- 🔧 **Extensive Format Support:** Preview text files, images, videos, documents, archives, and more!\n- ⚙️ **Easy Customization:** Tailor the script to your needs or contribute improvements via pull requests.\n\n---\n\n### 💻 **Installation**\n\n#### Using Nix with Flakes Enabled\n\nTo get started with Nix, add the following to your Nix Flake:\n```nix\n{\n    inputs = {\n        fzf-preview.url = \"github:niksingh710/fzf-preview\";\n        fzf-preview.inputs.nixpkgs.follows = \"nixpkgs\";\n    };\n}\n```\n\n# Add it to your system packages:\n# configuration.nix\n```nix\n{\n    home.packages = [ inputs.fzf-preview.packages.${pkgs.system}.default ]; # for home-manager\n    environment.systemPackages = [ inputs.fzf-preview.packages.${pkgs.system}.default ];\n}\n```\n\n#### Quick Run Without Installation\n\nIf you want to test it without installing:\n```sh\nnix shell \"github:niksingh710/fzf-preview\"\nfzf --preview 'fzf-preview {}'\n```\n\n#### Home-Manager Integration\n\nTo run the `fzf-preview` script in Ctrl-T mode:\n```nix\n{\n    programs.fzf = let\n      fzf-preview = inputs.fzf-preview.packages.${pkgs.system}.default;\n    in {\n      enable = true;\n      fileWidgetOptions = binds ++ [ \"--preview='${lib.getExe fzf-preview}' {}\" ];\n    };\n}\n```\n\n---\n\n### ⚙️ **For Non-Flake Users**\n\nThe `default.nix` has been written with non-flake users in mind. If you're not using flakes, you can still test the project using the traditional `nix-build` command. To install it, you can fetch the package directly without needing to rely on flakes.\n\nTo test it:\n```bash\nnix-build\n```\n\nTo install it:\n```bash\nnix-env -f default.nix -iA packageName\n```\n\nThis makes it easy to use, regardless of whether you're using flakes or not!\n\n---\n\n### 📦 For Non-NixOS Users\n\nThis repository provides a simple Bash script that can be used with FZF.\n\n#### Installation\n1. **Download** the `fzf-preview` script and place it in your `PATH`.\n   A recommended location is the `~/.local/bin` directory.\n\n2. **Add to PATH**: Update your `.bashrc` or `.zshrc` file:\n   ```bash\n   export PATH=\"$PATH:$HOME/.local/bin\"\n   ```\n\n3. **Reload Configuration**:\n   ```bash\n   source ~/.bashrc  # or ~/.zshrc\n   ```\n\n4. **Install Dependencies**:\n   Make sure to manually install any required dependencies for the script. Ensure all tools it uses are available on your system.\n\n### Usage\nOnce installed, you can use the script with FZF like this:\n```bash\nfzf --preview 'fzf-preview {}'\n```\n\n🎉 Enjoy a seamless FZF preview experience!\n\n---\n\nThis version uses emojis to highlight key points and make the section more visually appealing.---\n\n### 🛠️ **Dependencies**\n\nThe following tools are required to enable various preview features:\n- 📝 `file`, `jq`, `bat`, `glow`, `w3m`, `eza`, `openssl`\n- 📦 Archive tools: `atool`, `p7zip`, `libcdio`\n- 📚 Document tools: `odt2txt`, `catdoc`, `gnumeric`\n- 🎬 Media tools: `exiftool`, `chafa`, `mediainfo`, `ffmpegthumbnailer`, `poppler_utils`\n\n\u003e **Note:** If you're using Nix, dependencies are automatically managed for you. 🎉\n\n---\n\n### 🖼️ **Image Previews**\n\nImage previews support video thumbnails, PDF front pages, and more. You can easily preview images in various formats, thanks to tools like `chafa` and `ffmpegthumbnailer`.\n\nNeed more preview capabilities? 🙌\n- 📌 **Open an issue**\n- 💡 **Submit a pull request**\n- 💬 **Share your ideas**\n\n---\n\n### 🤝 **Contributing**\n\nWe welcome contributions! 👐 If you'd like to improve `fzf-preview` or package it for other package managers, feel free to submit a PR. Here are some ways you can contribute:\n- Bug fixes 🐛\n- New preview formats ✨\n- Documentation improvements 📖\n\n### 📅 **Planned Enhancements**\n- Add `fzf-preview` to **nixpkgs**. 🚀\n- Detect commands and show help in the preview window. ⌨️\n\n---\n\nThanks for checking out `fzf-preview`! If you have any questions or suggestions, feel free to open an issue. Happy previewing! 😄\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniksingh710%2Ffzf-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fniksingh710%2Ffzf-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniksingh710%2Ffzf-preview/lists"}