● starship Modules

479 2026-08-14 note ♑︎

starshipstarship is a minimal, fast, and customizable prompt for any shell. It's written in Rust and provides informative prompts while staying extremely fast. starship works with fish, bash, zsh, and other shells. Installation bash brew install starship Setup Add to… provides modular prompt components that can be customized individually. Each module shows specific information when relevant.

Common Modules

Directory

[directory]
truncation_length = 3
truncate_to_repo = true

Git Branch

[git_branch]
symbol = "🌱 "
truncation_length = 20

Git Status

[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = "🗃️"
renamed = "📛"
deleted = "🗑️"

Node.js

[nodejs]
symbol = "⬢ "
detect_files = ["package.json", ".node-version"]
detect_folders = ["node_modules"]

Python

[python]
symbol = "🐍 "
pyenv_version_name = true
detect_files = ["requirements.txt", ".python-version", "pyproject.toml"]

Rust

[rust]
symbol = "🦀 "
detect_files = ["Cargo.toml"]

Go

[golang]
symbol = "🐹 "
detect_files = ["go.mod", "go.sum"]

Advanced Modules

Custom Modules

[custom.foo]
when = "test -f foo.txt"
symbol = "🔥 "
style = "bold red"
description = "foo.txt exists"

Environment Variables

[env_var]
variable = "MY_ENV_VAR"
symbol = "🌍 "
style = "bold yellow"

Time

[time]
disabled = false
format = "🕙 [$time]($style) "
time_format = "%T"

Username

[username]
show_always = true
style_user = "bold red"
style_root = "bold black"

Hostname

[hostname]
ssh_only = true
format = "on [$hostname](bold red) "

Module Detection

Most modules support file and folder detection:

[nodejs]
detect_files = ["package.json", ".node-version"]
detect_folders = ["node_modules"]
detect_extensions = ["js", "ts", "jsx"]

Module Styling

Each module supports style strings:

[directory]
style = "bold cyan"

Style options:

• Colors: black, red, green, yellow, blue, magenta, cyan, white
• Modifiers: bold, dim, italic, underline
• Background: bg:color

Module Order

Control the order of modules in the prompt:

format = """
[┌───────────────────>](bold green)
[│](bold green) $directory$git_branch$git_status
[│](bold green) $nodejs$python$rust$golang
[└─>](bold green) $character
"""

Right Prompt

Enable a right-side prompt:

right_format = "$time"

Module Configuration

Each module can be:

• Disabled globally: disabled = true
• Conditionally enabled: when = "command"
• Customized with symbols, styles, and formats

Modules make starship flexible and informative while keeping the prompt clean and relevant.

For overall starship configuration, see starship Configurationstarship configuration uses TOML format in ~/.config/starship.toml. The file is reloaded automatically when saved. Basic Configuration toml Don't print a new line at the start of the prompt addnewline = false Replace the "❯" symbol in the prompt with "➜"…. For the main starship overview, see starshipstarship is a minimal, fast, and customizable prompt for any shell. It's written in Rust and provides informative prompts while staying extremely fast. starship works with fish, bash, zsh, and other shells. Installation bash brew install starship Setup Add to….