Perform common operations

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

Requirements

• Any Nerd Font

Install homebrew and execute the following commands

brew install superfile

Just copy and paste this one-line command:

bash -c "$(curl -sLo- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)"

Or wget:

bash -c "$(wget -qO- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)"

nix profile install github:MHNightCat/superfile#superfile

nix profile install github:MHNightCat/superfile#superfile

inputs = {
  superfile = {
    url = "github:MHNightCat/superfile";
  };
  # ...
};

let
  system = "x86_64-linux";
in {
  environment.systemPackages = with pkgs; [
    # ...
    inputs.superfile.packages.${system}.default  ];
}

Once the font is installed if superfile isn't working make sure to update your terminal preferences to use the font.

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

Requirements

• golang

Build Steps

Clone this repo 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

• Linux
• MacOS
• Windows

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

Click me to the plugins wiki

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 over time! 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:

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

and change:

theme = "gruvbox"

to:

theme = "theme-name"

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!

Click me to see the hotkey list

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

If you want to contribute please follow the contribution guide

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

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

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