+1
Daily
+81
Weekly
+276
Monthly
24,087
stars
832
forks
60
watchers
996
prs
609
issues
26
releases
README
superfile is supported by the community.
!Homebrew downloads !GitHub downloads
!
Demo
| Perform common operations |
| -------------------------- |
| ! |
Content
- Demo
- Content
- Installation
- macOS and Linux
- Windows
- Powershell
- Winget
- Scoop
- More installation methods
- Build
- For macOS/Linux
- For Windows
- Start superfile
- Supported Systems
- Tutorial
- Plugins
- Themes
- Hotkeys
- Notes
- Troubleshooting
- Uninstalling
- macOS and Linux
- Windows
- Contributing
- Thanks
- Support
- Core maintainer
- Contributors
- Powered by
- Star History
- ༼ つ ◕\_◕ ༽つ Please share.
Installation
macOS and Linux
bash
bash -c "$(curl -sLo- https://superfile.dev/install.sh)"
If you want to inspect the script, see : install.sh
Windows
Powershell
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
powershell
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
- golang
Build Steps
Clone this repository using the following command:
git clone https://github.com/yorukot/superfile.git --depth=1
Enter the downloaded directory:
bash
cd superfile
For macOS/Linux
Run the build.sh file:
bash
./build.sh
Add the binary file to your $PATH, e.g., in /usr/local/bin:
bash
sudo mv ./bin/spf /usr/local/bin
For Windows
bash
go build -o bin/spf.exe
Edit System Environment Variables and add superfile repo's bin directory to your PATH
Start superfile
bash
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
Click me to the plugins wiki
Themes
Click me to the theme wiki
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
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 locatiTop issues
#938Flaky CI tests45 comments · 2025-07-16#1193bat command flags used in superfile are not configurable and can clash with user's bat config28 comments · 2025-12-12#688Windows package tagged as Trojan by windows defender24 comments · 2025-03-07#706Make cd_on_quit more cross platform and more clean.13 comments · 2025-03-12#914Feature: Restore previous panel layout and directories (with current working dir override)12 comments · 2025-06-28#1111Configurable height of lower panels11 comments · 2025-10-05#294enhancement: Custom file previews11 comments · 2024-07-13#1170Display unmounted disk10 comments · 2025-12-01
Discussions
#1711CHANGELOG | superfile1 comments · 2026-11-15#1687Archive previews (ZIP, etc.)0 comments · 2026-10-17#1673Stop wrapping behavior on top and bottom of file list0 comments · 2026-10-03#1672Batch checksum copying similar to Offshoot0 comments · 2026-10-03#1657Make superfile usuable as a xdg-desktop-portal backend.0 comments · 2026-09-12#1643Idea: External fzf integration for instant recursive tree search (via tea.ExecProcess)1 comments · 2026-08-28#1626Chinese (Simplified) localization support0 comments · 2026-08-10#1567image sequence stacks?1 comments · 2026-07-27
Latest release
v1.6.0 v1.6.0 2026-06-07This release focuses on preview reliability, richer file metadata, configurable sidebar behavior, and a refreshed website and logo design, alongside navigation improvements, better error messages, refactoring, dependency updates, and bug fixes. Install: Click me to know how to install Highlights - Improved image and file preview reliability through the Bubble Tea v2 migration. Thanks @lazysegtree for the implementation - New website & logo design. Thanks @elvisdragonmao for the implementation - Added richer file metadata, including binary architecture detection for ELF/PE/Mach-O, L