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 locati