Note: This project is still a work in progress. Please read the entire README before cloning or using, and proceed at your own risk.
Fzfm is a terminal-based file manager inspired by tools like Ranger, nnn, lf, vifm, etc. It leverages bash, fzf, and Kitty (via icat for image preview) to offer a user-friendly way to navigate and manage files from the terminal. Fzfm supports file previewing, directory traversal, and viewing images (albeit with limited functionality).
To install Fzfm, follow these steps:
- Clone the repository:
git clone https://github.com/jdpedersen1/fzfm.git
- Navigate to the
fzfmdirectory:cd fzfm - Grant execution permissions to the scripts:
chmod +x *.sh - Optionally, add the directory to your
PATHif you prefer to run the scripts without typing the full path.
fzf: For fuzzy file searching and selection.
The following programs are required for file previews. You can modify the scripts to use alternatives if needed:
libreoffice: For opening Word documents.zathura: For opening PDFs.mpv: For video playback.sxiv: For image viewing.neovimorvim: For editing text files.gimp: For opening.xcffiles.bat: For previewing text files with syntax highlighting.kitty: For image preview (Kitty terminal emulator is required for this feature).
- Traverse file tree.
- Preview files and directories before opening.
- Open files with appropriate applications based on file type.
- Create new files and directories.
- Delete files and directories.
- Image preview (requires
kittyterminal emulator).
- Copy files and directories.
- Warning: If the target directory already contains a file or directory with the same name, it will be overwritten.
- File extraction and compression.
- File renaming functionality.
- Unexpected behavior may occur after creating files or directories. This is being investigated.