Starship

Minimal, blazing-fast prompt for any shell

Quick summary

Starship is a cross-shell prompt that shows you relevant context: current directory, git branch and status, Node.js/Python/.NET versions, command duration, and more -- all with zero configuration to get started. Starship works in Fish, Bash, Zsh, and PowerShell. The bootstrapper enables it automatically in your Fish config.

What is it?

Starship is a cross-shell prompt that shows you relevant context: current directory, git branch and status, Node.js/Python/.NET versions, command duration, and more -- all with zero configuration to get started. Starship works in Fish, Bash, Zsh, and PowerShell. The bootstrapper enables it automatically in your Fish config.

Usage

Starship works automatically -- you don't need to run any commands. The prompt will show:

  • Current directory
  • Git branch and status (dirty/staged/ahead/behind)
  • Runtime versions when in a project directory
  • Command execution time if > 2s
  • Exit code of the last command if non-zero

Customization

Create ~/.config/starship.toml to customize every part of the prompt:

Disable the package module

[package] disabled = true

Change the Node.js symbol

[nodejs] symbol = "⬢ " format = "via [$symbol($version )]($style)"

Changes take effect immediately -- no reload needed.

Tips

Run starship preset nerd-font-symbols -o ~/.config/starship.toml to use Nerd Font icons.
See all configuration options at starship.rs/config.