Awesome
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="/asset/superfilelogowhite.png" /> <source media="(prefers-color-scheme: light)" srcset="/asset/superfilelogoblack.png" /> <img alt="superfile LOGO" src="/asset/superfilelogowhite.png" /> </picture>
Demo
| Perform common operations |
|---|
 |
Content
- Installation
- Build
- Supported Systems
- Tutorial
- Plugins
- Themes
- Hotkeys
- Contributing
- Troubleshooting
- Thanks
Installation
Quick install
Using bash (Support MacOS and linux)
bash -c "$(curl -sLo- https://superfile.netlify.app/install.sh)"
Using powershell (Support Windows)
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
Build
You can build the source code yourself by using these steps:
Requirements
Build Steps
Clone this repository using the following command:
git clone https://github.com/yorukot/superfile.git --depth=1
Enter the downloaded directory:
cd superfile
Run the build.sh file:
./build.sh
Add the binary file to your $PATH, e.g., in /usr/local/bin:
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 to briefly understand how to use superfile!
Plugins
Themes
Hotkeys
[!WARNING] If you are vim/nvim user please change your default hotkeys config to vim version!
Click me to see the hotkey wiki
Troubleshooting
Click me to see common problem fix
Uninstalling
MacOS and Linux
On MacOS and Linux, you can uninstall superfile by simply removing the binary. If you installed superfile with sudo, run
sudo rm /usr/local/bin/spf
If you installed superfile without sudo, run
rm ~/.local/bin/spf
If you don't rember, just try removing both.
Window
To uninstall superfile on Windows, use this powershell script.
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
Thanks
Support
- a Star on my GitHub repository would be nice 🌟
- You can buy a coffee for me 💖
Contributors
Thanks to all the contributors for making this project even greater!
<a href="https://github.com/yorukot/superfile/graphs/contributors"> <img src="https://contrib.rocks/image?repo=yorukot/superfile" /> </a>Star History
THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating!
<a href="https://star-history.com/#yorukot/superfile&Timeline"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=yorukot/superfile&type=Timeline&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=yorukot/superfile&type=Timeline" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=yorukot/superfile&type=Timeline" /> </picture> </a> <div align="center">