Spaceship Prompt
A minimal, customizable Zsh prompt that shows git status, runtimes, and other useful info.
- Stars
- 20.6k
- Forks
- 971
- Licence
- MIT
- Language
- Shell
- Last update
- 10 days ago
- Type
- Dev tool
What it is
Spaceship is a prompt for the Zsh shell, the command line used on many Mac and Linux systems. The prompt line is the text you see before each command, and Spaceship uses it to show details such as your Git repository status, the version of languages or packages in the current folder, Docker or Kubernetes context, and battery level. It is designed to be simple by default and can be configured section by section.
- See the current Git branch and whether your repo has uncommitted changes while you type commands
- Show the Node.js, Python or Rust version for the project folder you are in
- Check the active Kubernetes context or Docker version before running a deployment command
- Add a custom section that displays information of your own choosing, as described in the Advanced Usage docs
Great for
- Zsh users who want useful information in their prompt without much setup
- People who work in Git repositories and want to see branch and status at a glance
- Developers using languages such as Node.js, Python, Rust or Go who want runtime versions shown in the prompt
- Users of Oh-My-Zsh, prezto, zim, zinit or similar Zsh managers who want a ready-made theme
Not ideal for
- Users of shells other than Zsh, such as Bash or Fish, because the project requires Zsh (v5.2 or newer)
- Anyone who does not want to install a Nerd Font or Powerline Font, since the README says one is required for icons to display correctly
- People who want a fully static prompt with no extra background checks, since the README describes many sections that show live information
How to get it
- 1
Install with a package manager
You'll need: Zsh 5.2 or newer · Powerline Font or Nerd Font installed and set in your terminal · Homebrew, npm, or a supported Zsh plugin manager (depending on the method you choose)
Install with Homebrew
brew install spaceshipInstall with npm
npm install -g spaceship-prompt - 2
Run it
- Install Spaceship using one of the methods in the README, such as Homebrew or npm.
- Add the source line the installer or README gives you to your ~/.zshrc file.
- Open a new terminal window or run exec zsh to reload your shell.
- Confirm the prompt appears and that icons render correctly in your terminal font.
- 3
Get the most out of it
- Install a Nerd Font, which the README says works even better than Powerline Font, so icons display properly
- Follow the Configuration docs at spaceship-prompt.sh to turn sections on or off and change their behavior
- Use the Advanced Usage docs to create a custom section that shows information you choose
- Pair Spaceship with zsh-autosuggestions and zsh-syntax-highlighting, as shown in the README screenshot
Downloads
Strengths
- Installs through many common Zsh plugin managers and Homebrew, npm, and the AUR
- Works well out of the box and can be customized in detail through its configuration docs
- Large, long-running open-source project with an MIT license and an active community on Discord
Trade-offs
- Requires Zsh 5.2 or newer and a Powerline or Nerd Font, so setup is not zero-effort for beginners
- Shows many sections, so users who want a very sparse prompt will need to turn options off
- The README is truncated in this analysis, so some details of the configuration system could not be verified here
How it compares
| Project | Stars | Type | Level | Updated | Best for |
|---|---|---|---|---|---|
| spaceship-prompt (this) | 20.6k | Dev tool | beginner | 10 days ago | Zsh users who want useful information in their prompt without much setup |
| powerlevel10k | 55.3k | Dev tool | beginner | 2 months ago | Zsh users who want a informative prompt that does not slow down typing |
| pure | 14.5k | Dev tool | beginner | 30 days ago | Developers who use zsh and want a simple, readable prompt |
| oh-my-posh | 23.7k | Dev tool | intermediate | 4 days ago | Developers who want their terminal prompt to show extra context |
| oh-my-fish | 11.4k | Dev tool | beginner | 1 months ago | Fish shell users who want an easy way to add themes and prompt customizations |
| ohmyzsh | 190k | Dev tool | beginner | 4 days ago | People who already use zsh and want a ready-made configuration without writing it from scratch |
Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.