Skip to content
This repository has been archived by the owner on Feb 3, 2021. It is now read-only.
/ spacefish Public archive

πŸš€πŸŸ The fish shell prompt for astronauts

License

Notifications You must be signed in to change notification settings

matchai/spacefish

Repository files navigation

spacefish fish shell theme

Spacefish πŸš€πŸŸ

Fish Shell prompt for Astronauts.

Mac OSX & Linux CI Status Windows CI Status Fish Version

Built with ❀︎ by Matan Kushner and contributors
A port of Spaceship ZSH by Denys Dovhan

Spacefish is a minimalistic, powerful and extremely customizable Fish Shell prompt. It combines everything you may need for convenient work, without unnecessary complications, like a real spacefish.

Spaceship with Hyper and One Dark

Vist Troubleshooting for instructions to recreate this terminal setup.

Features

  • Clever hostname and username displaying.
  • Indicator if user is root.
  • Prompt character turns red if the last command exits with non-zero code.
  • Current Git branch and rich repo status:
    • ? β€” untracked changes;
    • + β€” uncommitted changes in the index;
    • ! β€” unstaged changes;
    • Β» β€” renamed files;
    • ✘ β€” deleted files;
    • $ β€” stashed changes;
    • = β€” unmerged changes;
    • ⇑ β€” ahead of remote branch;
    • ⇣ β€” behind of remote branch;
    • ⇕ β€” diverged changes.
  • Indicator for jobs in the background (✦).
  • Current Node.js version, through nvm/nodenv/n (β¬’).
  • Current Docker version and connected machine (🐳).
  • Current Ruby version, through rvm/rbenv/chruby/asdf (πŸ’Ž).
  • Current Go version (🐹).
  • Current PHP version (🐘).
  • Current Rust version (π—₯).
  • Current version of Haskell GHC Compiler, defined in stack.yaml file (Ξ»).
  • Current Conda version (πŸ…’).
  • Current Amazon Web Services (AWS) profile (☁️) (Using named profiles).
  • Current Python pyenv (🐍).
  • Current Kubectl context (☸️).
  • Package version, if there is a package in current directory (πŸ“¦).
  • Current battery level and status:
    • ⇑ - charging;
    • ⇣ - discharging;
    • β€’ - fully charged.
  • Optional exit-code of last command.
  • Optional time stamps 12/24hr in format.
  • Execution time of the last command if it exceeds 5 seconds.

Want more features? Please open an issue or send pull request!

Requirements

To get spacefish working correctly, you will need:

Installation

$ fisher add matchai/spacefish
$ omf install spacefish

Customization

Spacefish works really well out of the box, but you can customize your fish to your heart's content!

  • Options β€” Tweak section's behavior with tons of options.

You have the ability to customize or disable specific elements of Spacefish. All options must be overridden in your config.fish.

Troubleshooting

Having issues? Take a look at our Troubleshooting page.

Still struggling? Please file an issue, describe your problem, and we will gladly help you.

License

MIT Β© Matan Kushner