Perform common operations |
---|
- Installation
- Build
- Supported Systems
- Tutorial
- Plugins
- Themes
- Hotkeys
- Contributing
- Todo list
- Star History
I am still working on different installation methods like
homebrew
andsnap
Requirements
- Any
Nerd Font
If you want to use homebrew please install go
first!
brew tap mhnightcat/superfile https://github.com/MHNightCat/homebrew-superfile.git && brew install superfile
You can go to the latest release and download the binary file. Once it is downloaded please excrate the file after that enter the following in your terminal:
cd ~/Download
chmod +x ./spf
sudo mv ./spf /bin/
Click to expand
Add superfile to your flake inputs:
inputs = {
superfile = {
url = "github:MHNightCat/superfile";
};
# ...
};
Then you can add it to your packages:
let
system = "x86_64-linux";
in {
environment.systemPackages = with pkgs; [
# ...
inputs.superfile.packages.${system}.default ];
}
Warning
This is a reminder that you must use a Nerd font
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
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!
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.json
using your preferred editor:
$EDITOR ~/.config/superfile/config.json
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.json
and copy the existing theme's json to your own theme file
Don't forget to change the theme
variable in config.json
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
See the todo list in here
THANKS FOR All OF YOUR STARS!