Repository: yorukot/superfile

Stars: 17141

README.md Copy Chapter

<div align="center">

<p>
<h4>
<a href="https://ko-fi.com/yorukot">superfile is supported by the community.</a>
</h4>
<div align="center" markdown="1">
^{Special thanks to:}
<br>
<br>
<a href="https://www.warp.dev/?utm_source=github&utm_medium=referral&utm_campaign=superfile">
<img alt="Warp sponsorship" width="300" src="/asset/warp.png">
</a>

Warp, the AI terminal for developers Warp, the AI terminal for developers')" title="Copy section prompt for LLMs"> Copy Section

</div>
<hr>

</div>

<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>

!Homebrew downloads
!GitHub downloads


</div>

Demo Copy Chapter

| Perform common operations |
| ------------------------- |
|  |

Content Copy Chapter

- Installation
- Build
- Supported Systems
- Tutorial
- Plugins
- Themes
- Hotkeys
- Notes
- Contributing
- Troubleshooting
- Thanks
- Support
- Core maintainer
- Contributors
- Powered by
- Star History

Installation Copy Chapter

macOS and Linux Copy Section

bash -c "$(curl -sLo- https://superfile.dev/install.sh)"

Windows Copy Section

#### Powershell

powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"

#### Winget

winget install --id yorukot.superfile

#### Scoop

scoop install superfile

More installation methods Copy Section

Build Copy Chapter

You can build the source code yourself by using these steps:

Requirements

- golang

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

For macOS/Linux Copy Section

./build.sh

Add the binary file to your $PATH, e.g., in /usr/local/bin:

sudo mv ./bin/spf /usr/local/bin

For Windows Copy Section

go build -o bin/spf.exe

Edit System Environment Variables and add superfile repo's bin directory to your PATH

Start superfile Copy Chapter

spf

Supported Systems Copy Chapter

- \[x\] Linux
- \[x\] macOS
- \[x\] Windows (Not fully supported yet)

Tutorial Copy Chapter

After you install superfile, you can go here to briefly understand how to use superfile!

Plugins Copy Chapter

Click me to the plugins wiki

Themes Copy Chapter

Click me to the theme wiki

Hotkeys Copy Chapter

Click me to see the hotkey wiki

Notes Copy Chapter

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 Copy Chapter

Click me to see common problem fix

Uninstalling Copy Chapter

macOS and Linux Copy Section

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 Copy Section

To uninstall superfile on Windows, use this powershell script.

powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/uninstall.ps1'))"

Contributing Copy Chapter

If you want to contribute please follow the contribution guide

Click me to see changelog

Thanks Copy Chapter

Support Copy Section

- a Star on my GitHub repository would be nice 🌟
- You can buy a coffee for me 💖


Core maintainer Copy Section

We welcome anyone who wants to become a core maintainer. Feel free to reach out!

- @yorukot - Original author and maintainer
- @lazysegtree - Core maintainer

Contributors Copy Section

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>

Powered by Copy Section

<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 Copy Section

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">

༼ つ ◕_◕ ༽つ Please share. Copy Chapter

</div>