Build your prompt in the terminal

Install from source

The CLI package is not yet published to npm. Until its release, use the repository build:

git clone https://github.com/nicklambourne/starship-prompt-builder.git
cd starship-prompt-builder
corepack enable
pnpm install --frozen-lockfile
pnpm build:cli
node packages/cli/dist/index.js --help

Requires Node.js 22 or newer and a UTF-8 terminal at least 60 columns wide. CI checks Linux, macOS, and Windows on Node.js 22 and 24; patched Nerd Fonts are optional for icon-heavy presets.

First run

node packages/cli/dist/index.js edit ~/.config/starship.toml
node packages/cli/dist/index.js preview ~/.config/starship.toml --scenario cloud --no-color
node packages/cli/dist/index.js validate ~/.config/starship.toml --json

If the default config does not exist, interactive mode starts from a preset. Explicit files for preview, validation, and export must exist. Use ? for keys or : for searchable actions. Press Ctrl+S to review the exact regenerated file before saving. Detected disk changes block saving. Saves coordinate with this CLI, but external editors can still race an existing-file replacement.

Preview and share

Environment inputs are simulated. Select a built-in scenario with 2, then p, or edit files, tool versions, Git, cloud, battery, and custom output directly. Scenario JSON and portable workspace files are separate from starship.toml.

cat starship.toml | node packages/cli/dist/index.js validate - --json
node packages/cli/dist/index.js share starship.toml
node packages/cli/dist/index.js completions zsh

Share links contain configuration only. Export a workspace from the TOML pane when the simulated environment must travel with it. Recovery drafts are stored privately outside the config and never replace it automatically.

Troubleshooting

If the preview looks different from your shell, compare the selected scenario, terminal width, and font. --no-color removes ANSI color from headless previews. The save review marks regenerated TOML; comments and source formatting may not survive an edited save. An unchanged save keeps the original bytes.

For a terminal that intercepts shortcuts, use : to search for Undo, Redo, Save, module settings, and other actions. If an editor has changed the file in the meantime, reload it or use Save As.