Favicon of Superfile

Superfile

superfile is an open-source terminal file manager written in Go with a modern TUI, custom themes, plugins, and hotkeys.

Superfile website screenshot
Superfile GitHub repository preview

superfile is a terminal-based file manager built in Go with the Bubble Tea framework. It targets developers and power users who spend most of their time in a terminal and want a file manager that looks modern, supports plugins and themes, and stays keyboard-driven. If you're used to tools like ranger or nnn but want something with a friendlier default look and active theming support, this fits.

Key features

  • Modern TUI: a styled terminal interface built on Bubble Tea, with a demo GIF in the repo showing common file operations.
  • Custom themes: swap the look of the file manager via the theme wiki and config files.
  • Plugin support: extend functionality through community plugins listed in the plugin wiki.
  • Configurable hotkeys: default keybindings can be changed, including a vim-style preset for vim/nvim users.
  • Auto update check: checks GitHub for a newer release once every 24 hours and prompts you; can be disabled via auto_check_update in the config.
  • Cross-platform installers: install scripts for macOS/Linux, PowerShell and Winget/Scoop for Windows.
  • Simple uninstall: dedicated uninstall scripts for both macOS/Linux and Windows.

Ideal use cases

superfile works well if you manage files mostly from the terminal and want quick navigation, copy/move/delete operations, and a visually organized layout without leaving the shell. It's a good fit for developers on Linux or macOS who already live in tmux/terminal-heavy workflows and want a file manager that's easy to theme and extend with plugins.

It's less of a fit if you need a fully mature Windows experience: the README explicitly notes Windows support isn't complete yet. It's also not built for GUI-style drag-and-drop workflows or for users who want deep integration with a specific desktop environment's file manager conventions (like Nautilus or Finder extensions). If you need scriptable batch file operations as a primary use case, a shell-based tool or find/rsync combo may serve you better than a TUI file manager.

Installation

On macOS and Linux, run the install script:

bash -c "$(curl -sLo- https://superfile.dev/install.sh)"

On Windows, use PowerShell:

powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"

Or install via Winget:

winget install --id yorukot.superfile

Or via Scoop:

scoop install superfile

To build from source, you need Go installed. Clone the repo and build:

git clone https://github.com/yorukot/superfile.git --depth=1
cd superfile
./build.sh
sudo mv ./bin/spf /usr/local/bin

On Windows, build with:

go build -o bin/spf.exe

Then add the repo's bin directory to your PATH via System Environment Variables.

Once installed, start it with:

spf

To uninstall on macOS/Linux, run the uninstall script:

bash -c "$(curl -sLo- https://superfile.dev/uninstall.sh)"

On Windows, run the uninstall PowerShell script listed in the README.

Frequently asked questions

Share:

Stars
22.8K
Forks
833
Last commit
6 days ago
Repository age
2 years
License
MIT
Self-hosted
No
Activity score
81/100
View Repository
Ad
Favicon

 

  
 

Similar to Superfile

Favicon

 

  
 
Favicon

 

  
 
Favicon