yorukot / superfile
git clone https://github.com/yorukot/superfile.git
v1.6.0 · 4mo ago
Pretty fancy and modern terminal file manager
+12
stars, 24h · #2,981
+~54
stars, 7 days · #3,836
+~230
stars, 30 days · #3,518
24k
★ total · +0% this week
835
forks · 292 open issues
Star history (as recorded here)
LanguageGo
LicenseMIT
Created2024-03-19 (2y ago)
Last pushtoday
Watchers62
OwnerUser
GitHub topics
bubbleteaclifile-managerfilemanagerfilesystemgolanghacktoberfestlinux-appterminal-appterminal-basedtui
Links
- GitHub: github.com/yorukot/superfile
- Homepage: https://superfile.dev
- Releases · Issues · Hacker News mentions
README excerpt
superfile is supported by the community. ## 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 [code] If you want to inspect the script, see : install.sh ### Windows #### Powershell [code] If you want to inspect the script, see : install.ps1 #### Winget [code] #### Scoop [code] ### 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: [code] Enter the downloaded directory: [code] ### For macOS/Linux Run the `build.sh` file: [code] Add the binary file to your $PATH, e.g., in `/usr/local/bin`: [code] ### For Windows [code] Edit System Environment Variables and add superfile repo's `bin` directory to your PATH ## Start superfile [code] ## 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 [code] 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. [code] 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