discover · compare · collections · requirements · contribute · feed · watching · stats · help with your tokens
yorukot/superfile · source
Snapshot 0 · 2026-11-04T12:47:27Z · Go · MIT
Content fingerprint
7116887ae8dd8b323c746a9ec7fa29ef5b3bdb8f0ffbc9d3ba8d8cc00ec638acGitHub description at capture
Pretty fancy and modern terminal file manager
README at capture
<div align="center">
<h4>superfile is supported by the community.</h4>
<a href="https://ko-fi.com/yorukot">
<img alt="Donate to superfile on Ko-fi" src="https://ko-fi.com/img/githubbutton_sm.svg">
</a>
<hr>
</div>
<div align="center">
<br>
<picture>
<source width="300" media="(prefers-color-scheme: dark)" srcset="website/src/assets/superfile-night.svg" />
<source width="300" media="(prefers-color-scheme: light)" srcset="website/src/assets/superfile-day.svg" />
<img alt="superfile LOGO" src="website/src/assets/superfile-day.svg" />
</picture>
<br><br>
[](https://raw.githubusercontent.com/yorukot/superfile/refs/heads/main/LICENSE) [](https://discord.gg/YYtJ23Du7B) [](https://github.com/yorukot/superfile/releases/latest)   [](https://www.coderabbit.ai/)
</div>
## Demo
| Perform common operations |
| -------------------------- |
|  |
## Content
- [Demo](#demo)
- [Content](#content)
- [Installation](#installation)
- [macOS and Linux](#macos-and-linux)
- [Windows](#windows)
- [Powershell](#powershell)
- [Winget](#winget)
- [Scoop](#scoop)
- [More installation methods](#more-installation-methods)
- [Build](#build)
- [For macOS/Linux](#for-macoslinux)
- [For Windows](#for-windows)
- [Start superfile](#start-superfile)
- [Supported Systems](#supported-systems)
- [Tutorial](#tutorial)
- [Plugins](#plugins)
- [Themes](#themes)
- [Hotkeys](#hotkeys)
- [Notes](#notes)
- [Troubleshooting](#troubleshooting)
- [Uninstalling](#uninstalling)
- [macOS and Linux](#macos-and-linux-1)
- [Windows](#windows)
- [Contributing](#contributing)
- [Thanks](#thanks)
- [Support](#support)
- [Core maintainer](#core-maintainer)
- [Contributors](#contributors)
- [Powered by](#powered-by)
- [Star History](#star-history)
- [༼ つ ◕\_◕ ༽つ Please share.](#-つ-_-つ-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](./website/public/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](./website/public/install.ps1)
#### [Winget](https://winget.run/)
```powershell
winget install --id yorukot.superfile
```
#### [Scoop](https://scoop.sh/)
```
scoop install superfile
```
### More installation methods
[Click me to check on how to install](https://superfile.dev/getting-started/installation/)
## Build
You can build the source code yourself by using these steps:
**Requirements**
- [golang](https://go.dev/doc/install)
**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](https://superfile.dev/getting-started/tutorial/) to briefly understand how to use superfile!
## Plugins
[Click me to the plugins wiki](https://superfile.dev/list/plugin-list/)
## Themes
[Click me to the theme wiki](https://superfile.dev/configure/custom-theme/)
## Hotkeys
> [!WARNING] If you are vim/nvim user please change your default hotkeys config to vim version!
[**Click me to see the hotkey wiki**](https://superfile.dev/configure/custom-hotkeys/)
## 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**](https://superfile.dev/configure/superfile-config/)
## Troubleshooting
[**Click me to see common problem fix**](https://superfile.dev/troubleshooting/)
## Uninstalling
### macOS and Linux
```bash
bash -c "$(curl -sLo- https://superfile.dev/uninstall.sh)"
```
If you want to inspect the script, see : [uninstall.sh](./website/public/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
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](https://superfile.dev/configure/config-file-path/) for all locations.
## Contributing
If you want to contribute please follow the [contribution guide](./CONTRIBUTING.md)
[**Click me to see changelog**](https://superfile.dev/changelog)
## Thanks
### Support
- a Star on my GitHub repository would be nice 🌟
- You can buy a coffee for me 💖
[](https://ko-fi.com/G2G1JEGGC)
### Core maintainer
> We welcome anyone who wants to become a core maintainer. Feel free to reach out!
- **[@yorukot](https://github.com/yorukot)** - Original author and maintainer
- **[@lazysegtree](https://github.com/lazysegtree)** - Core maintainer
### Contributors
**Thanks to all the contributors for making this project even greater!**
<a href="https://github.com/yorukot/superfile/graphs/contributors">
<img src="https://gthanks.yorukot.me/image?target=yorukot%2Fsuperfile" />
</a>
### Powered by
<a href="https://jb.gg/OpenSource"><img alt="JetBrains logo" align="right" width="200" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg"></a>
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!
<a href="https://www.star-history.com/?repos=yorukot%2Fsuperfile&type=date&legend=top-left">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=yorukot/superfile&type=date&theme=dark&legend=top-left&sealed_token=nEoMOYsfp1zwZ7rT-Fm6VR2yTa6cwW35VR0BwVxTuE8Dt17vRcRIQUFXeWdh6lZixlAl5e_fIVFs2Xe4cRdvAnexR5Q6JqlGVZK05Iu0mko8gYLjTdjq0g" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=yorukot/superfile&type=date&legend=top-left&sealed_token=nEoMOYsfp1zwZ7rT-Fm6VR2yTa6cwW35VR0BwVxTuE8Dt17vRcRIQUFXeWdh6lZixlAl5e_fIVFs2Xe4cRdvAnexR5Q6JqlGVZK05Iu0mko8gYLjTdjq0g" />
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=yorukot/superfile&type=date&legend=top-left&sealed_token=nEoMOYsfp1zwZ7rT-Fm6VR2yTa6cwW35VR0BwVxTuE8Dt17vRcRIQUFXeWdh6lZixlAl5e_fIVFs2Xe4cRdvAnexR5Q6JqlGVZK05Iu0mko8gYLjTdjq0g" />
</picture>
</a>
<div align="center">
## ༼ つ ◕_◕ ༽つ Please share.
</div>