starship Cheatsheet

Q: How do I install starship?

macOS: `brew install starship`. Linux: `curl -sS https://starship.rs/install.sh | sh`. Windows: `scoop install starship`. Then add `eval "$(starship init SHELL)"` to your shell config (.bashrc/.zshrc/etc).

Q: Where is the config file?

Default path: `~/.config/starship.toml`. Use the `STARSHIP_CONFIG` environment variable to set a custom path. Config is in TOML format — each module is a section header like `[git_branch]` or `[nodejs]`.

Q: How do I use presets?

Run `starship preset --list` to see available presets. Apply one with `starship preset PRESET_NAME -o ~/.config/starship.toml`. Popular presets include `tokyo-night`, `pastel-powerline`, and `nerd-font-symbols`.

Q: How do I diagnose slow prompts?

Run `starship timings` to see how long each module takes to render. Run `starship explain` to see which modules are active and why. Use `starship module MODULE_NAME` to test a single module.

starship is a fast, highly customizable cross-shell prompt written in Rust (58K⭐). Supports Bash, Zsh, Fish, PowerShell, Elvish, and more with modular TOML-based configuration.

Updated: 2026-07-20·38 commands

Quick Start

bash
starship init bash              # Initialize for Bash (add to .bashrc)
starship init zsh               # Initialize for Zsh (add to .zshrc)
starship init fish              # Initialize for Fish


Preset Themes

bash
starship preset --list                        # List all presets
starship preset tokyo-night -o ~/.config/starship.toml    # Apply Tokyo Night
starship preset nerd-font-symbols -o ~/.config/starship.toml # Nerd Font symbols


Configuration Commands

bash
starship config               # View current config
starship config add_newline false   # Disable leading newline
starship config character.style 'bold green'  # Set character style


Diagnostics

bash
starship timings              # Check module render times
starship explain              # Explain prompt segments
starship bug-report           # Generate bug report info
starship print-config         # Show full resolved config

Install & Setup(10)

Command	Level	Example
`curl -sS https://starship.rs/install.sh \| sh` Install starship via official install script	Basic	`curl -sS https://starship.rs/install.sh \| sh`
`brew install starship` Install starship via Homebrew (macOS)	Basic	`brew install starship`
`scoop install starship` Install starship via Scoop (Windows)	Basic	`scoop install starship`
`starship init bash` Initialize starship for Bash (add to .bashrc)	Basic	`eval "$(starship init bash)"`
`starship init zsh` Initialize starship for Zsh (add to .zshrc)	Basic	`eval "$(starship init zsh)"`
`starship init fish` Initialize starship for Fish	Basic	`starship init fish \| source`
`starship init powershell` Initialize starship for PowerShell	Basic	`Invoke-Expression (&starship init powershell)`
`starship init elvish` Initialize starship for Elvish	Intermediate	`eval (starship init elvish)`
`STARSHIP_CONFIG` Environment variable to set custom config path	Intermediate	`export STARSHIP_CONFIG=~/.config/starship/custom.toml`
`STARSHIP_CACHE` Environment variable to set custom cache directory	Intermediate	`export STARSHIP_CACHE=~/.cache/starship-custom`

Configuration(6)

Command	Level	Example
`starship config` View current starship configuration	Basic	`starship config`
`starship config KEY VALUE` Set a config key-value (e.g. format, add_newline)	Basic	`starship config add_newline false`
`~/.config/starship.toml` Default starship config file path (TOML format)	Basic	`vim ~/.config/starship.toml`
`starship config --help` Show starship config subcommand help	Basic	`starship config --help`
`starship config palette` Set color palette	Intermediate	`starship config palette catppuccin_mocha`
`starship config format` Customize full prompt format	Expert	`starship config format '$all' # Or custom: starship config format '[$username](bold blue) at [$hostname](red) in [$directory](green) ' '$git_branch$character'`

Module Config(7)

Command	Level	Example
`starship config character` Configure prompt character (e.g. use ➜)	Intermediate	`starship config character.style 'bold green' starship config character.success_symbol '[➜](bold green)'`
`starship config git_branch` Configure Git branch module	Intermediate	`starship config git_branch.format '[$branch](bold purple)' starship config git_branch.only_attached false`
`starship config nodejs` Configure Node.js version display	Intermediate	`starship config nodejs.format 'via [⬢ $version](bold green)' starship config nodejs.disabled false`
`starship config directory` Configure directory display format	Intermediate	`starship config directory.truncation_length 3 starship config directory.truncate_to_repo false`
`starship config python` Configure Python venv display	Intermediate	`starship config python.format 'via [🐍 $version](bold yellow)' starship config python.disabled false`
`starship config docker` Configure Docker context display	Intermediate	`starship config docker.format 'via [🐳 $context](bold blue)' starship config docker.disabled false`
`starship config kubernetes` Configure Kubernetes context display	Intermediate	`starship config kubernetes.format '[$context](bold purple) in [$namespace](bold cyan)' starship config kubernetes.disabled false`

Prompt Customization(6)

Command	Level	Example
`starship preset` List all available preset themes	Basic	`starship preset --list`
`starship preset PRESET_NAME -o ~/.config/starship.toml` Apply a preset theme to config file	Basic	`starship preset nerd-font-symbols -o ~/.config/starship.toml`
`starship preset bracketed-segments` Apply bracketed-segments preset	Basic	`starship preset bracketed-segments -o ~/.config/starship.toml`
`starship preset pastel-powerline` Apply pastel-powerline preset	Basic	`starship preset pastel-powerline -o ~/.config/starship.toml`
`starship preset tokyo-night` Apply Tokyo Night preset	Basic	`starship preset tokyo-night -o ~/.config/starship.toml`
`starship toggle` Toggle module visibility in prompt	Intermediate	`starship toggle rust`

Advanced(9)

Command	Level	Example
`starship session` Generate shell init code for session	advanced	`starship session --help`
`starship timings` Analyze module rendering time (perf diagnosis)	Intermediate	`starship timings`
`starship explain` Explain what each segment of the current prompt means	Intermediate	`starship explain`
`starship bug-report` Generate info needed for a bug report	Basic	`starship bug-report`
`starship toml` Convert config file to standard TOML format	advanced	`starship toml < ~/.config/starship.toml`
`starship --version` Show starship version	Basic	`starship --version`
`starship completions` Generate shell completion script	advanced	`starship completions bash > /usr/share/bash-completion/completions/starship`
`starship module` Render a single module (for debugging)	Expert	`starship module git_branch`
`starship print-config` Print the full resolved configuration	Intermediate	`starship print-config`

FAQ

How do I install starship?

Where is the config file?

How do I use presets?

How do I diagnose slow prompts?

This cheatsheet is compiled from official tool documentation. Last updated: 2026-07-20.