Skip to content
master
Go to file
Code

README.md

Focus has shifted to the development of Starship, the successor to Spacefish. If you are interested in contributing or using it, come take a look!

spacefish fish shell theme

Spacefish ๐Ÿš€๐ŸŸ

Fish Shell prompt for Astronauts.

Mac OSX & Linux CI Status Fish Version GitHub License

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 Amazon Web Services (AWS) profile (โ˜๏ธ) (Using named profiles).
  • Current Python virtualenv.
  • Current Conda version (๐Ÿ…’).
  • Current Elixir Version (๐Ÿ’ง).
  • Current Python pyenv (๐Ÿ).
  • Current .NET SDK version, through dotnet-cli (.NET).
  • 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 install 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.

Contributors

Thanks goes to these wonderful people (emoji key):

Matan Kushner
Matan Kushner

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€ โš ๏ธ ๐Ÿ”ง ๐ŸŽจ
Tiffany Le-Nguyen
Tiffany Le-Nguyen

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€ โš ๏ธ
Snuggle
Snuggle

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€ โš ๏ธ
Jaskaran Bindra
Jaskaran Bindra

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Konstantin Labun
Konstantin Labun

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Kyle Holzinger
Kyle Holzinger

๐Ÿ’ป ๐Ÿ“–
Salmanul Farzy
Salmanul Farzy

๐Ÿ’ป ๐Ÿ‘€
owais
owais

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Samantha Enders
Samantha Enders

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Evan Relf
Evan Relf

๐Ÿ’ป ๐Ÿ“–
Jason Etcovitch
Jason Etcovitch

๐Ÿ’ป ๐Ÿ“–
hrvoj3e
hrvoj3e

๐Ÿ› ๐Ÿ’ป
Michael Newman
Michael Newman

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Konrad
Konrad

๐Ÿ›
Will Neville
Will Neville

๐Ÿ›
Daniel Trautmann
Daniel Trautmann

๐Ÿ’ป
Jonas ร–hlander
Jonas ร–hlander

๐Ÿ›
lindsay
lindsay

๐Ÿ“–
Brad
Brad

๐Ÿ’ป
Nam Nguyen
Nam Nguyen

๐Ÿ’ป
Austin Ziegler
Austin Ziegler

๐Ÿ‘€
Konstantinos Koukopoulos
Konstantinos Koukopoulos

๐Ÿ’ป โš ๏ธ

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT ยฉ Matan Kushner