README.md

Spacefish 🚀🐟

Fish Shell prompt for Astronauts.

Website | Install | Features | Options | API

_{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.

_{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:

• fish (v2.7.0 or newer)
• Powerline Font must be installed and enabled in your terminal.

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 🐛 💻 📖 👀 ⚠️ 🔧 🎨	Tiffany Le-Nguyen 🐛 💻 📖 👀 ⚠️	Snuggle 🐛 💻 📖 👀 ⚠️	Jaskaran Bindra 💻 📖 ⚠️	Konstantin Labun 💻 📖 ⚠️	Kyle Holzinger 💻 📖	Salmanul Farzy 💻 👀
owais 💻 📖 ⚠️	Samantha Enders 💻 📖 ⚠️	Evan Relf 💻 📖	Jason Etcovitch 💻 📖	hrvoj3e 🐛 💻	Michael Newman 🐛 💻 📖 ⚠️	Konrad 🐛
Will Neville 🐛	Daniel Trautmann 💻	Jonas Öhlander 🐛	lindsay 📖	Brad 💻	Nam Nguyen 💻	Austin Ziegler 👀
Konstantinos Koukopoulos 💻 ⚠️

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

License

MIT © Matan Kushner