Installing stellar

Get the stellar binary onto your machine, then point it at a theme from the hub.

This installs the binary to ~/.local/bin. Check what the script does here.

Prefer copies over symlinks?

stellar applies themes by symlinking starship.toml - set STELLAR_APPLY_MODE=copy if you'd rather have it copy the file instead.

This installs the binary to %LOCALAPPDATA%\stellar\bin and adds it to your PATH. Check what the script does here.

Windows applies themes by copying

Symlinks on Windows need Developer Mode or admin privileges, so on Windows stellar copies the theme file over starship.toml instead of symlinking it. This means there's no hot-reload while editing local themes - re-run stellar apply after making changes. See how it works for details.

Verify the install

Shell completions

stellar can generate completions for its commands as well as the theme names in your local cache, for your shell of choice.

Completing themes you haven't downloaded yet

Completion only suggests themes from your local cache, so it's instant and works offline. Set STELLAR_COMPLETION_ONLINE=1 to have it suggest hub themes too - that adds up to ~2 seconds of network lookup per completion, and falls back to local-only when the hub can't be reached.

Bash

Or source it directly from your .bashrc:

Zsh

Fish

PowerShell

Add this to your $PROFILE:

Uninstalling

The uninstall scripts mirror the install ones: they remove the binary and stellar's config directory.

This also removes %LOCALAPPDATA%\stellar\bin from your PATH again.

From an installed binary, stellar uninstall does the same thing. Your prompt keeps working: if starship.toml is a symlink into stellar's cache, it is turned into a plain file with the current theme's content first. Then ~/.config/stellar is removed - including your backups and your own themes, which it lists before asking - unless you pass --keep-config. Pass --yes to skip the confirmation.

Telemetry

stellar sends an anonymous ping on install, update and uninstall (random id, CLI version, OS) so the hub can count installs - no themes, paths or IPs. Turn it off with STELLAR_NO_TELEMETRY=1 or DO_NOT_TRACK=1. Details are in the privacy policy.

Next steps

Browse themesFind your next prompt on the stellar hub.CommandsEvery stellar command with examples: apply, preview, remove and more.