## Demo
| Perform common operations |
| ------------------------- |
|  |
## Content
- [Installation](#installation)
- [Build](#build)
- [Supported Systems](#supported-systems)
- [Tutorial](#tutorial)
- [Plugins](#plugins)
- [Themes](#themes)
- [Hotkeys](#hotkeys)
- [Notes](#notes)
- [Contributing](#contributing)
- [Troubleshooting](#troubleshooting)
- [Thanks](#thanks)
- [Support](#Support)
- [Contributors](#contributors)
- [Star History](#star-history)
## Installation
### MacOS and Linux
```bash
bash -c "$(curl -sLo- https://superfile.netlify.app/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.netlify.app/install.ps1'))"
```
If you want to inspect the script, see : [install.ps1](./website/public/install.ps1)
#### [Scoop](https://scoop.sh/)
```
scoop install superfile
```
### 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
```
### 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.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/)
## 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.netlify.app/configure/superfile-config/)
## 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, runw
```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)
[**Click me to see changelog**](https://superfile.netlify.app/changelog)
## 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!
