geremarchive / catfm

🐟 an extensible interactive shell for the UNIX operating system

catfm

An extensible interactive shell for the UNIX operating system

About

catfm, or Compact And Tweakable File Manager is an interactive shell for your UNIX system that runs right in your terminal. It not only allows the user to manage files, but to complete complex actions through simple user defined keyboard shortcuts

Features

• Customizable file formating
• Opening files in your favorite programs
• Script intergration
• Bookmarks
• Tabs
• A customizable bar
• Overall aesthetic customizability

Dependencies

• go 1.13
• a POSIX enviroment and shell
• a terminal that supports cursor adressing, etc.

Building

Clone the repository:

git clone http://github.com/geremachek/catfm

Move into the catfm/ directory and type go build

Move the binary to somewhere in your path

Configuration

You can configure the program in the config/config.go file before compiling. This speeds up the program as it doesn't have to read and parse a giant config file everytime you start up the program

I also recommend looking at the tcell documentation on color and styles

cd on exit

shell function (put this in your .shellrc):

fm() {
	catfm && cd "$(< /tmp/kitty)"
}

Tutorial

Coming soon...

Todo

• Run program/script/command on keypress
• Run custom commands in the bar
• Add hotkeys for directories
• Add file searching
• Add file renaming
• Add ability to customize the keys for delete, move, copy, movement, etc.
• Move to top or bottom screen
• Add tabs
• Improve config file and keybinds