superfile README

The project's README from github.com/yorukot/superfile. As one markdown file: README.md.

superfile is supported by the community.

Donate to superfile on Ko-fi

superfile LOGO

License MIT Discord Link Release Homebrew downloads GitHub downloads CodeRabbit Pull Request Reviews

Demo

Perform common operations

Content

Installation

macOS and Linux

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

If you want to inspect the script, see : install.sh

Windows

Powershell

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

If you want to inspect the script, see : install.ps1

Winget

winget install --id yorukot.superfile

Scoop

scoop install superfile

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

For macOS/Linux

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

For Windows

go build -o bin/spf.exe

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

Start superfile

spf

Supported Systems

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

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

If you want to inspect the script, see : uninstall.sh

Windows

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

If you want to contribute please follow the contribution guide

Click me to see changelog

Thanks

Support

ko-fi

Core maintainer

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

Contributors

Thanks to all the contributors for making this project even greater!

Powered by

JetBrains logo

Thanks to JetBrains team for providing open-source licenses to support the maintenance of superfile.

Star History

THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating!

Star History Chart

༼ つ ◕_◕ ༽つ Please share.

superfile (yorukot/superfile)

Searching Database…

23.9K ·GitHub
这是什么东西?一个美观现代的终端文件管理器——用 Go 编写的键盘驱动 TUI 应用,可以直接在终端里浏览和管理文件。
怎么安装?macOS 或 Linux 上运行提供的安装脚本(install.sh);Windows 上用 PowerShell 脚本、Winget 或 Scoop。也可以从源码构建,但需要先装好 Go。
支持 Windows 吗,还是只有 Mac 和 Linux?三大桌面平台都支持:Linux、macOS 和 Windows——不过 README 里提到 Windows 支持还不够完善。
有没有教程可以学操作?有——安装后,README 里有一个 superfile 的简短使用教程,另外还有快捷键、主题和插件的独立 wiki。
superfile 会自动保持更新吗?如果距上次检查超过 24 小时,它会去 GitHub 检查有没有新版本,有更新时会提示你。在配置里把 autocheckupdate 设为 false 即可关闭这个功能。
以后不用了怎么卸载?有专门的卸载脚本:macOS 和 Linux 用 uninstall.sh,Windows 用 PowerShell 卸载脚本。
What are similar projects?gh-dash, gitlogue, yazi, toast, ranger, edit, posting, micro
Creator
yorukot
Size
89.3 MB
Stars
23.9K
Age
2y
Commits · 90 Days