Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yorukot/superfile
Pretty fancy and modern terminal file manager
https://github.com/yorukot/superfile
bubbletea cli file-manager filemanager filesystem golang linux-app terminal-app terminal-based terminal-file-manager tui
Last synced: 4 days ago
JSON representation
Pretty fancy and modern terminal file manager
- Host: GitHub
- URL: https://github.com/yorukot/superfile
- Owner: yorukot
- License: mit
- Created: 2024-03-19T15:49:52.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T21:45:13.000Z (7 days ago)
- Last Synced: 2024-10-29T15:09:28.887Z (6 days ago)
- Topics: bubbletea, cli, file-manager, filemanager, filesystem, golang, linux-app, terminal-app, terminal-based, terminal-file-manager, tui
- Language: Go
- Homepage: https://superfile.netlify.app
- Size: 53.3 MB
- Stars: 5,853
- Watchers: 12
- Forks: 126
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - yorukot/superfile - Pretty fancy and modern terminal file manager (Go)
- awesome-linux-ricing - superfile
- my-awesome - yorukot/superfile - manager,filemanager,filesystem,golang,linux-app,terminal-app,terminal-based,terminal-file-manager,tui pushed_at:2024-10 star:5.9k fork:0.1k Pretty fancy and modern terminal file manager (Go)
README
## Demo
| Perform common operations |
| ------------------------- |
|  |
## Content
- [Installation](#installation)
- [Build](#build)
- [Supported Systems](#supported-systems)
- [Tutorial](#tutorial)
- [Plugins](#plugins)
- [Themes](#themes)
- [Hotkeys](#hotkeys)
- [Contributing](#contributing)
- [Troubleshooting](#troubleshooting)
- [Thanks](#thanks)
- [Support](#Support)
- [Contributors](#contributors)
- [Star History](#star-history)
## Installation
### Quick install
Using bash (Support MacOS and linux)
```bash
bash -c "$(curl -sLo- https://superfile.netlify.app/install.sh)"
```
Using powershell (Support Windows)
```powershell
powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.netlify.app/install.ps1'))"
```
### More installation methods
[Click me to check on how to install](https://superfile.netlify.app/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
```
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
```
## Supported Systems
- \[x\] Linux
- \[x\] MacOS
- \[x\] Windows (Not fully supported yet)
## Tutorial
After you install superfile, you can go [here](https://superfile.netlify.app/getting-started/tutorial/) to briefly understand how to use superfile!
## Plugins
[Click me to the plugins wiki](https://superfile.netlify.app/list/plugin-list/)
## Themes
[Click me to the theme wiki](https://superfile.netlify.app/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.netlify.app/configure/custom-hotkeys/)
## Troubleshooting
[**Click me to see common problem fix**](https://superfile.netlify.app/troubleshooting/)
## Uninstalling
### MacOS and Linux
On MacOS and Linux, you can uninstall superfile by simply removing the binary. If you installed superfile with sudo, run
```bash
sudo rm /usr/local/bin/spf
```
If you installed superfile without sudo, run
```bash
rm ~/.local/bin/spf
```
If you don't rember, just try removing both.
### Window
To uninstall superfile on Windows, use this powershell script.
```powershell
powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.netlify.app/uninstall.ps1'))"
```
## Contributing
If you want to contribute please follow the [contribution guide](./CONTRIBUTING.md)
## Thanks
### Support
- a Star on my GitHub repository would be nice 🌟
- You can buy a coffee for me 💖
[](https://ko-fi.com/G2G1JEGGC)
### Contributors
**Thanks to all the contributors for making this project even greater!**
### Star History
**THANKS FOR All OF YOUR STARS!**
Your stars are my motivation to keep updating!
## ༼ つ ◕_◕ ༽つ Please share.