mhnightcat / superfile

Pretty fancy and modern terminal file manager

Demo

Perform common operations

Content

• Installation
  • Homebrew
  • Install pre-built binaries
  • Windows
  • NixOs
  • Font
• Build
• Supported Systems
• Tutorial
• Plugins
• Themes
  • Use an existing theme
  • Create your own theme
• Hotkeys
• Contributing
• Troubleshooting
• Thanks
  • Support
  • Contributors
  • Star History

Installation

You can go here to know how to install

Build

You can build the source code yourself by using these steps:

Requirements

• golang

Build Steps

Clone this repository using the following command:

git clone https://github.com/MHNightCat/superfile.git

Enter the downloaded directory:

cd superfile

Run the build.sh file:

./build.sh

Add the binary file to your $PATH, e.g., in /usr/local/bin:

mv ./bin/spf /usr/local/bin

Supported Systems

• Linux
• MacOS
• Windows (Not fully supported yet)

Tutorial

After you install superfile, you can go here to briefly understand how to use superfile!

Plugins

Click me to the plugins wiki

Themes

Use an existing theme

You can go to theme list to find one you like!

We only have a few themes at the moment, but we will be making more overtime! You can also submit a pull request for your own theme!

copy theme_name in:

Theme name: theme_name

Edit config.toml using your preferred editor:

Tip

If your OS is macOS the file path should be in the ~/Library/Application Support/superfile/config.toml

$EDITOR ~/.config/superfile/config.toml

and change:

theme = "gruvbox"

to:

theme = "theme-name"

Create your own theme

If you want to customize your own theme, you can go to ~/.config/superfile/theme/YOUR_THEME_NAME.toml and copy the existing theme's json to your own theme file

Don't forget to change the theme variable in config.toml to your theme name.

If you are satisfied with your theme, you might as well put it into the default theme list!

Hotkeys

Click me to see the hotkey list

Tip

If your OS is macOS the file path should be in the ~/Library/Application Support/superfile/hotkeys.toml

You can change all hotkeys in ~/.config/superfile/hotkeys.toml

"Normal mode" is the default browsing mode

Global hotkeys cannot conflict with other hotkeys (The only exception is the special hotkey).

The hotkey ranges are found in hotkeys.toml

Troubleshooting

Click me to see common problem fix

Contributing

If you want to contribute please follow the contribution guide

Thanks

Support

• a Star on my GitHub repository would be nice 🌟
• You can buy a coffee for me 💖

Contributors

Thanks to all the contributors for making this project even greater!

Star History

THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating!