Spaceship is a minimalistic, powerful and extremely customizable Zsh prompt. Prompt is what you see when you type a command. It can show a lot of useful tips, saving your time and making the user experience smooth and pleasant. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.

^{Visit Frequently Asked Question for similar setup and find more examples with different color schemes in Screenshots wiki-page.}

Here are some sneak peeks of what Spaceship can show:

• Clever hostname and username displaying
• Repository statuses (Git and Mercurial are supported)
• Runtime environments for various languages (Node.js, Rust, Python, Ruby, Swift, Go, PHP and many others)
• Docker version, Kubernetes context and connected machine
• Package version (npm, lerna, cargo, composer and others)
• Battery level and status
• Indicator for jobs in the background ✦
• A lot of useful information
• Custom information of your choice

Want more features? Please, open an issue or send a pull request.

Before we begin, let's make sure you have the following installed:

• Zsh (v5.2 or recent) must be installed. Run the following command to check your version of Zsh:

  echo $ZSH_VERSION #> 5.8.1

• Powerline Font or Nerd Font (even better) must be installed and used in your terminal. Fira Code is a popular choice. To check if Powerline Font works for you, run:

  echo -e "\xee\x82\xa0" #> 

Here are a few popular methods to install Spaceship. Select the one you use from the list below:

brew install spaceship

echo "source $(brew --prefix)/opt/spaceship/spaceship.zsh" >>! ~/.zshrc

git clone https://github.com/spaceship-prompt/spaceship-prompt.git "$ZSH_CUSTOM/themes/spaceship-prompt" --depth=1

ln -s "$ZSH_CUSTOM/themes/spaceship-prompt/spaceship.zsh-theme" "$ZSH_CUSTOM/themes/spaceship.zsh-theme"

npm install -g spaceship-prompt

zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules

zimfw install

antigen theme spaceship-prompt/spaceship-prompt

antibody bundle spaceship-prompt/spaceship-prompt

zinit light spaceship-prompt/spaceship-prompt

zgen load spaceship-prompt/spaceship-prompt spaceship

zplug "spaceship-prompt/spaceship-prompt", use:spaceship.zsh, from:github, as:theme

[plugins.spaceship]
github = "spaceship-prompt/spaceship-prompt"

sheldon add spaceship --github spaceship-prompt/spaceship-prompt

git clone https://aur.archlinux.org/spaceship-prompt.git
cd spaceship-prompt
makepkg -si

yay -S spaceship-prompt

mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-prompt.git "$HOME/.zsh/spaceship"

source "$HOME/.zsh/spaceship/spaceship.zsh"

Spaceship works well out of the box, but you can customize almost everything if you want.

• ⚙️ Configuration — Tweak the section's behavior with tons of options.
• 😎 Advanced Usage — Learn how to create a custom section, benefit of per-directory configuration and more.

Additionally, join our community in Discord and follow our Twitter for updates.

We're glad to accept contributions from developers of all skill levels! If you are interested in contributing to Spaceship, please take a look at our Contribution Guide for more details. If you're looking for an easy way into the project, take one of the issues with good first issue label.

If you are fluent in any other language besides English, we greatly appreciate any help with translating our documentation in other languages. If you would like to help, join the team of translators on our Crowdin.

If you're interested in helping other people, answer questions asked by other users of Spaceship and help to solve their issues. Additionally, join our Discord to discuss Spaceship and help people who need help.

If you really enjoy this project, you can contribute financially. Any contribution is highly appreciated, even the smallest one. There are several ways to donate:

• Recurring donations:
  • GitHub Sponsors
  • Open Collective
  • Patreon
• One-time donations:
  • GitHub Sponsors
  • Buy Me A Coffee
  • Monobank Jar
• Crypto donations:
  • Ethereum: 0x5C9496De5E51D48daf28354DC04d8f9D33955559
  • Bitcoin: bc1q5ezjvpgftmx42f9qgdf5lscjz43uh4jf02uvje

Find answers on our troubleshooting page or get help from our community.

Issues • Discussions • Discord

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

Here's a list of related projects that have been inspired by Spaceship ZSH.

• denysdovhan/dotfiles - Dotfiles of Spaceship's author from which Spaceship is originated.
• matchai/spacefish - A port of Spaceship ZSH for fish shell intending to achieve complete feature parity.
• starship/starship - A blazing-fast, cross-shell prompt written in Rust, heavily inspired by Spaceship ZSH.

MIT © Denys Dovhan