- Go 74.2%
- Astro 7.1%
- MDX 6.2%
- CSS 4.5%
- Python 4.1%
- Other 3.8%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Fixes #1700 ## Description Prevent a panic when an SPF prompt command produces no tokens, such as whitespace-only input or an environment variable that expands to an empty string. The prompt now safely ignores input with no tokens instead of indexing an empty slice. ## Tests - `go test ./...`: **passed** - `go fmt ./...`: **passed** - `golangci-lint run`: reports 2 findinds in unchanged files: ``` src/cmd/debug_info.go:127:1: cognitive complexity 21 of func `(*debugPrinter).checkDependency` is high (> 20) (gocognit) func (dp *debugPrinter) checkDependency(name string, flag string) { ^ src/internal/config_function.go:32:2: named return "toggleFooter" with type "bool" found (nonamedreturns) toggleFooter bool, zClient *zoxidelib.Client) { ^ 2 issues: * gocognit: 1 * nonamedreturns: 1 ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **Bug Fixes** * Avoided an error when a prompt contains no arguments. <!-- end of auto-generated comment: release notes by coderabbit.ai --> |
||
| .github | ||
| asset | ||
| cd_on_quit | ||
| release | ||
| scripts | ||
| src | ||
| testsuite | ||
| vhs | ||
| website | ||
| .envrc | ||
| .gitignore | ||
| .golangci.yaml | ||
| build.sh | ||
| CONTRIBUTING.md | ||
| dev.sh | ||
| flake.lock | ||
| flake.nix | ||
| go.mod | ||
| go.sum | ||
| gomod2nix.toml | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| NOTICE.md | ||
| notice.tmpl | ||
| README.md | ||
Demo
| Perform common operations |
|---|
![]() |
Content
- Demo
- Content
- Installation
- Build
- Start superfile
- Supported Systems
- Tutorial
- Plugins
- Themes
- Hotkeys
- Notes
- Troubleshooting
- Uninstalling
- Contributing
- Thanks
- ༼ つ ◕_◕ ༽つ Please share.
Installation
macOS and Linux
bash -c "$(curl -sLo- https://superfile.dev/install.sh)"
If you want to inspect the script, see : install.sh
Windows
Powershell
powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"
If you want to inspect the script, see : install.ps1
Winget
winget install --id yorukot.superfile
Scoop
scoop install superfile
More installation methods
Click me to check on how to install
Build
You can build the source code yourself by using these steps:
Requirements
Build Steps
Clone this repository using the following command:
git clone https://github.com/yorukot/superfile.git --depth=1
Enter the downloaded directory:
cd superfile
For macOS/Linux
Run the build.sh file:
./build.sh
Add the binary file to your $PATH, e.g., in /usr/local/bin:
sudo mv ./bin/spf /usr/local/bin
For Windows
go build -o bin/spf.exe
Edit System Environment Variables and add superfile repo's bin directory to your PATH
Start superfile
spf
Supported Systems
- [x] Linux
- [x] macOS
- [x] Windows (Not fully supported yet)
Tutorial
After you install superfile, you can go here to briefly understand how to use superfile!
Plugins
Themes
Hotkeys
[!WARNING] If you are vim/nvim user please change your default hotkeys config to vim version!
Click me to see the hotkey wiki
Notes
We have an auto update functionality, that fetches superfile's latest released version from github (if last timestamp of last version check was less than 24 hours) and prints a prompt to user, if there is a newer version available.
You can turn this off, by setting auto_check_update to false in superfile config. Click me to see the config wiki
Troubleshooting
Click me to see common problem fix
Uninstalling
macOS and Linux
bash -c "$(curl -sLo- https://superfile.dev/uninstall.sh)"
If you want to inspect the script, see : uninstall.sh
Besides the spf binary in /usr/local/bin or ~/.local/bin, the script also deletes your config and data folders: ~/.config/superfile, ~/.local/share/superfile and ~/.local/state/superfile (or the $XDG_*_HOME locations if you set them, on Linux or macOS), and ~/Library/Application Support/superfile on macOS.
Windows
To uninstall superfile on Windows, use this powershell script.
powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/uninstall.ps1'))"
This script does not remove your config and data folder. Delete %LOCALAPPDATA%\superfile manually if you want it gone.
Other install methods
If you installed superfile another way (for example with a package manager), run spf pl before uninstalling to see where your config and data folders are, then delete them yourself. See config file path for all locations.
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 💖
Core maintainer
We welcome anyone who wants to become a core maintainer. Feel free to reach out!
- @yorukot - Original author and maintainer
- @lazysegtree - Core maintainer
Contributors
Thanks to all the contributors for making this project even greater!
Powered by
Thanks to JetBrains team for providing open-source licenses to support the maintenance of superfile.
Star History
THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating!

