starship(1)
Starship is a minimal, blazing-fast, and infinitely customizable shell prompt written in Rust.
Synopsis
starship [COMMAND] [OPTIONS]Description
Starship replaces your shell prompt with a fast, customizable prompt that displays relevant information about your project and system. It works with bash, zsh, fish, PowerShell, and other shells, automatically adapting to your environment and showing context like Git status, language versions, and command execution time.
The prompt is configured via a TOML file located at ~/.config/starship.toml, allowing you to customize colors, symbols, and which modules to display. Starship is written in Rust for performance and can be extended with custom modules.
Common options
| Flag | What it does |
|---|---|
init [SHELL] | Initialize starship for your shell (bash, zsh, fish, powershell, etc.) |
config | View or edit the configuration file |
bug-report | Print a report for bug submissions with system and shell information |
print-config | Print the current configuration as TOML |
render | Render the prompt with optional context parameters |
--profile [PROFILE] | Load a specific configuration profile |
--config [PATH] | Use a custom configuration file path |
--log-level [LEVEL] | Set logging verbosity (trace, debug, info, warn, error) |
Examples
Initialize starship for Zsh and load it in your current shell
starship init zsh | sourceOpen the starship configuration file in your default editor
starship configDisplay the current starship configuration as TOML to stdout
starship print-configAdd starship initialization to your Bash profile for persistence
echo 'eval "$(starship init bash)"' >> ~/.bashrcGenerate a detailed bug report with system and environment information
starship bug-reportRender and display the prompt using the nerd-font profile
starship render --profile nerd-fontRender the prompt using a custom configuration file
STARSHIP_CONFIG=~/.config/starship-minimal.toml starship renderEnable shell completions for Zsh (improves command suggestions)
starship completions zsh | source