https://github.com/zyrex-svg/fzffm
A simple fzf file manager with file preview capabilities, inspired by fff, lesspipe, and ranger.
https://github.com/zyrex-svg/fzffm
console file file-manager file-preview fzf fzf-scripts fzf-wrapper preview preview-video ranger sixel sixel-graphics terminal vim
Last synced: 3 days ago
JSON representation
A simple fzf file manager with file preview capabilities, inspired by fff, lesspipe, and ranger.
- Host: GitHub
- URL: https://github.com/zyrex-svg/fzffm
- Owner: Zyrex-svg
- License: gpl-3.0
- Created: 2025-04-23T01:54:56.000Z (4 days ago)
- Default Branch: main
- Last Pushed: 2025-04-24T00:05:22.000Z (3 days ago)
- Last Synced: 2025-04-24T00:58:45.227Z (3 days ago)
- Topics: console, file, file-manager, file-preview, fzf, fzf-scripts, fzf-wrapper, preview, preview-video, ranger, sixel, sixel-graphics, terminal, vim
- Language: Shell
- Size: 15.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fzffm: A Simple File Manager with Preview Capabilities 📂✨
  
Welcome to **fzffm**, a straightforward file manager that leverages the power of `fzf` for efficient file navigation and preview. Inspired by tools like `fff`, `lesspipe`, and `ranger`, **fzffm** combines simplicity with functionality, making it a perfect choice for users who want to manage files seamlessly in the terminal.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Preview Capabilities](#preview-capabilities)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features 🌟
- **Fast Navigation**: Quickly find files using fuzzy search.
- **File Previews**: View file contents directly in the terminal.
- **Terminal Compatibility**: Works with various terminal emulators.
- **Sixel Graphics Support**: Displays images directly in the terminal.
- **Integration with Vim**: Seamlessly open files in Vim for editing.
## Installation 🛠️
To get started with **fzffm**, you can download the latest release from the [Releases section](https://github.com/Zyrex-svg/fzffm/releases). Follow these steps:
1. Visit the [Releases section](https://github.com/Zyrex-svg/fzffm/releases).
2. Download the appropriate file for your system.
3. Execute the downloaded file.
Ensure you have `fzf` installed on your system for optimal performance. You can install `fzf` using the following command:
```bash
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
~/.fzf/install
```
## Usage 🚀
After installation, you can start using **fzffm** by running the following command in your terminal:
```bash
fzffm
```
This command opens the file manager interface, allowing you to navigate through your files. Use the arrow keys to move through the list and press `Enter` to open a file.
### Keyboard Shortcuts
- **Arrow Keys**: Navigate through files.
- **Enter**: Open the selected file.
- **Ctrl + C**: Exit the file manager.
## Preview Capabilities 👀
One of the standout features of **fzffm** is its ability to preview files. Whether you're working with text files, images, or videos, **fzffm** can display them right in your terminal.
### Supported File Types
- **Text Files**: Preview plain text files using `less`.
- **Images**: Display images using Sixel graphics.
- **Videos**: Use `mpv` or `ffplay` to preview video files.
To preview a file, simply select it and press the `P` key. The preview will open in a new pane.
## Contributing 🤝
We welcome contributions to **fzffm**! If you'd like to help improve the project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch and create a pull request.
Please ensure your code follows the existing style and includes tests where applicable.
## License 📄
**fzffm** is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
## Contact 📬
For questions or suggestions, feel free to reach out:
- **GitHub**: [Zyrex-svg](https://github.com/Zyrex-svg)
- **Email**: [email protected]
Thank you for using **fzffm**! We hope it enhances your file management experience in the terminal. For more updates, check the [Releases section](https://github.com/Zyrex-svg/fzffm/releases).