Superfile is a modern terminal file manager that recently caught my attention; itβs not only easy to use but is very user-friendly compared to its alternatives, such as Ranger, MC, or nnn.
It allows you to create files and directories, view (process, metadata, clipboard), provide a navigation pane, create multiple panels to work in two separate directories, support plugins, offer a variety of themes, and much more.
The project is new, so there have been active updates every week, allowing you to see new features quickly. Iβve also been using it for a few days, and honestly, one key factor in using DE in Linux for me was its easy-to-use file manager, but with Superfile, thereβs no need for that now.
Today, in this article, Iβll guide you on installing Superfile on Linux, using it, installing plugins, and changing the default theme.
Tutorial Details
Description | Superfile: A Modern CLI File Manager |
Difficulty Level | Low |
Root or Sudo Privileges | No |
OS Compatibility | Linux, macOS, and Windows (Kindof). |
Prerequisites | β |
Internet Required | Yes (for installation) |
How to Install Superfile on Linux
Prior to installation, Superfile relies on Nerd Font for displaying file and directory icons in the terminal, so make sure you install and enable it by reading our article on Nerd Font installation.
To install Superfile, you have multiple options, but the easiest and most trusted method is using the brew command. If you have HomeBrew installed on your Linux system or are using macOS, then run:
$ brew install superfile
Apart from HomeBrew, you can also install it using the shell script with curl or wget commands, or manually compile it from source, though we do not recommend these methods; if you insist, you can follow them to install Superfile.
So, to install Superfile using the shell script, simply execute your preferred command.
# Via Curl
$ bash -c "$(curl -sLo- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)"
# OR
# Via Wget
$ bash -c "$(wget -qO- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)"
To compile and build it yourself, run the following series of commands:
# Clone the project repository.
$ git clone https://github.com/MHNightCat/superfile.git
# Enter the downloaded directory and run the "build.sh" file.
$ cd superfile && ./build.sh
# Add the compiled binary to your "/bin" directory.
$ mv ./bin/spf /usr/local/bin
Thatβs it. You have now successfully installed Superfile on your system.
How to Use Superfile on Linux
Once the installation is complete, you can access the Superfile by using the βspf
β command.
To effectively work with Superfile, itβs essential to be familiar with the correct key bindings. For instance, use the βbβ key to focus on the navigation pane, the βpβ key for the process bar, βmβ for metadata, and βqβ or βEscβ to quit the Superfile.
In the file panel, you can use the arrow key for navigation, the βEnterβ key to open the active file (in the default application) or directory, the βBackspaceβ key to return, and βCtrl+fβ to search.
To maximize the workspace, you can quickly create multiple file panels (like tabs in File Manager) to work on multiple directory structures using the βCtrl+nβ key, press βTabβ to cycle between the file panels, and βCtrl+wβ to close the active file panel.
You can press βCtrl+hβ to see dotfiles (hidden files), the βcβ key to create a file, the βfβ key to create a directory, the βrβ key to rename the selected file or directory, βCtrl+cβ to copy, βCtrl+xβ to move the selected file or directory, βCtrl+vβ to paste, and βCtrl+dβ to delete them.
To edit the selected file using the default text editor, you can press βeβ. Additionally, press βCtrl+rβ to compress a file or directory (in Zip format), βCtrl+eβ to decompress, and the βvβ key to enable bulk selection mode, where the βEnterβ key can be used to select individual files. Once done, you can perform bulk file operations.
EDITOR
β environment variable.There are quite a few more hotkeys you can use to enhance your productivity while using Superfile. To check out the complete list, visit this page. If you want to edit any existing key binding, you can do so by editing βhotkeys.toml
β with your preferred text editor, either Nano or Vim.
# Via Nano
$ nano ~/.config/superfile/hotkeys.toml
# OR
# Via Vim
$ vim ~/.config/superfile/hotkeys.toml
Output:
As you can see, you have the option to add two different keys to a specific task, feel free to edit this file (but for safety, keep a backup before editing). Once done, save and close the file.
How to Install Plugins in Superfile
Superfile provides a plugin option to increase the built-in capabilities. At present, Superfile has only one plugin in its catalog, named Metadata, but due to its ongoing development, we anticipate more in the future.
Now, if you want to enable the Metadata plugin that allows you to see more information about the file or directory, such as modification date, access date, errors, file permissions, and more, you first need to install the required βexiftool
β package for this plugin.
# On Debian, Ubuntu, Mint, Pop!_OS, etc.
$ sudo apt install exiftool
# On RHEL, CentOS, Fedora, Rocky Linux, AlmaLinux, etc.
$ sudo dnf install exiftool
# On Arch, Manjaro, EndeavourOS, Garuda, etc.
$ sudo pacman -S perl-image-exiftool
Once installed, edit the βconfig.toml
β file and change βmetadata = false
β to βmetadata = true
β.
# Via Nano
$ nano ~/.config/superfile/config.toml
# OR
# Via Vim
$ vim ~/.config/superfile/config.toml
Output:
After editing the file, save and close it. Once youβve done this, you can view more metadata information of any file.
This way, when new plugins arrive in the future, you can easily install and activate them.
How to Install Themes in Superfile
The Superfile comes with multiple themes, such as Catpuccino (default), Dracula (my favorite), Kaolin, Nord (Wow), RosΓ© Pine, Tokyonight, and Gruvbox. You can check out the appearance of each theme on the theme list page.
The default theme is βCatpuccinoβ, which is decent, but I prefer the βDraculaβ; thus, to install it or any other theme, open the βconfig.toml
β file and specify the name of your chosen theme to βtheme = 'theme-name'
β derivative.
# Via Nano
$ nano ~/.config/superfile/config.toml
# OR
# Via Vim
$ vim ~/.config/superfile/config.toml
Output:
Once done, save and close the file, and check your themeβs look by opening Superfile.
Final Word
Thatβs it for this article. Today, you learned how to install and use the amazing modern Superfile CLI file manager, as well as how to install plugins and themes. Iβve been using it for a while, and itβs the closest thing to replacing any GUI file manager.
If you find it interesting or know of any other such tool, please leave a comment.
Till then, peace!
Are there any plans for a snap or flatpak or appimage versions to be made?
Not everyone wants to bloat their PC with golang sources for a one-time compilation of superfile.
Currently, these are the only available methods; if there are any updates, the article will be revised accordingly.
Use this url to install, insted of the raw github one :
https://superfile.netlify.app/install.sh