https://github.com/MHNightCat/superfile Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} MHNightCat / superfile Public * * Notifications * Fork 22 * Star 1.2k * Pretty fancy and modern terminal file manager github.com/mhnightcat/superfile License MIT license 1.2k stars 22 forks Branches Tags Activity Star Notifications * Code * Issues 16 * Pull requests 1 * Discussions * Actions * Projects 0 * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights MHNightCat/superfile This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit message Last commit date Latest commit History 443 Commits .github .github asset asset release release src src themeZip themeZip vhs vhs .gitignore .gitignore CONTRIBUTING.md CONTRIBUTING.md LICENSE LICENSE README.md README.md THEMELIST.md THEMELIST.md build.sh build.sh changelog.md changelog.md flake.lock flake.lock flake.nix flake.nix install.sh install.sh View all files Repository files navigation * README * MIT license superfile LOGO [demo] Demo Perform common operations [demo] Content * Installation + Homebrew + Install pre-built binaries + NixOs + Font * Build * Supported Systems * Tutorial * Plugins * Themes + Use an existing theme + Create your own theme * Hotkeys * Contributing * Thanks + Support + Contributors + Star History Installation Requirements * Any Nerd Font Homebrew Install homebrew and execute the following commands brew install superfile Install pre-built binaries Just copy and paste this one-line command: bash -c "$(curl -sLo- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)" Or wget: bash -c "$(wget -qO- https://raw.githubusercontent.com/MHNightCat/superfile/main/install.sh)" NixOS Click to expand Install with nix command line: nix profile install github:MHNightCat/superfile#superfile or nix profile install github:MHNightCat/superfile#superfile Install with flake: Add superfile to your flake inputs: inputs = { superfile = { url = "github:MHNightCat/superfile"; }; # ... }; Then you can add it to your packages: let system = "x86_64-linux"; in { environment.systemPackages = with pkgs; [ # ... inputs.superfile.packages.${system}.default ]; } Font Warning This is a reminder that you must use a Nerd font Once the font is installed if superfile isn't working make sure to update your terminal preferences to use the font. Build You can build the source code yourself by using these steps: Requirements * golang Build Steps Clone this repo using the following command: git clone https://github.com/MHNightCat/superfile.git 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: mv ./bin/spf /usr/local/bin Supported Systems * [*] Linux * [*] MacOS * [ ] Windows Tutorial After you install superfile, you can go here to briefly understand how to use superfile! Plugins Click me to the plugins wiki Themes Use an existing theme You can go to theme list to find one you like! We only have a few themes at the moment, but we will be making more over time! You can also submit a pull request for your own theme! copy theme_name in: Theme name: theme_name Edit config.toml using your preferred editor: $EDITOR ~/.config/superfile/config.toml and change: theme = "gruvbox" to: theme = "theme-name" Create your own theme If you want to customize your own theme, you can go to ~/.config/ superfile/theme/YOUR_THEME_NAME.toml and copy the existing theme's json to your own theme file Don't forget to change the theme variable in config.toml to your theme name. If you are satisfied with your theme, you might as well put it into the default theme list! Hotkeys Click me to see the hotkey list You can change all hotkeys in ~/.config/superfile/hotkeys.toml "Normal mode" is the default browsing mode Global hotkeys cannot conflict with other hotkeys (The only exception is the special hotkey). The hotkey ranges are found in hotkeys.toml Contributing If you want to contribute please follow the contribution guide Thanks Support * a Star on my Github repos would be nice * You can buy a coffee for me ko-fi Contributors Thanks to all the contributors for making this project even greater! [6874747073] Star History THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating! Star History Chart About Pretty fancy and modern terminal file manager github.com/MHNightCat/superfile Topics cli golang filemanager filesystem tui file-manager terminal-based linux-app terminal-app bubbletea terminal-file-manager Resources Readme License MIT license Activity Stars 1.2k stars Watchers 2 watching Forks 22 forks Report repository Releases 6 v1.1.2 Latest May 8, 2024 + 5 releases Sponsor this project * ko_fi ko-fi.com/night_cat Contributors 11 * @MHNightCat * @AnshumanNeon * @renovate[bot] * @lescx * @nonepork * @ndom91 * @dependabot[bot] * @dem0ngo * @pearcidar * @kblissett * @c3r5b8 Languages * Go 96.7% * Shell 2.3% * Nix 1.0% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.