๐Ÿš€๐ŸŸ A Fish Shell prompt for Astronauts
Clone or download
Latest commit caa12ae Nov 18, 2018

README.md

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 Julia version (เฎƒ).
  • 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.
  • Current Vi-mode mode.
  • 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

$ fisher add matchai/spacefish

Oh My Fish!

$ 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