Commands
Most commands take a theme identifier in the form author/slug@version.
The version is optional — when omitted, stellar uses the latest local
version if you have one cached, or downloads the latest version from the
hub.
| Command | Description |
|---|---|
stellar apply | Apply a theme (downloads it if needed) |
stellar preview | Preview a theme in a new terminal window |
stellar list | List cached themes |
stellar current | Show the currently applied theme |
stellar info | Show details about a theme |
stellar clean | Remove cached themes you're not using |
stellar remove | Remove one or more cached themes |
stellar rollback | Switch back to the previously applied theme |
stellar update | Update the stellar CLI itself |
stellar version | Show the installed version and check for updates |
stellar uninstall | Remove stellar, keeping your current prompt as a plain file |
stellar completion | Generate shell completions |
apply
Applies a theme, making it your active starship config.
Starship configs may contain custom
commands, which run arbitrary
shell code every time your prompt is drawn. When a theme contains any,
stellar warns you, links you to the theme's page so you can read the config,
and asks for confirmation before applying it.
--force (or -f) skips that confirmation. Only use it for themes you've
read yourself, or in scripts applying a theme you already trust.
preview
Opens a new terminal window with the theme applied, without changing your active config.
stellar preview currently only spawns terminals on macOS and Linux.
list
Lists all themes currently cached locally.
current
Shows which theme is currently applied.
info
Shows metadata for a theme, such as its description and available versions.
clean
Removes cached theme versions you're not currently using, freeing up
space in ~/.config/stellar/.
remove
Removes a cached theme, either entirely or a specific version.
By default stellar refuses to remove the theme you're currently using, so
you don't end up with a starship.toml pointing at a file that's gone.
Pass --force (or -f) when you mean it.
rollback
Switches back to whichever theme was applied before the current one.
update
Updates the stellar CLI binary itself to the latest release.
uninstall
Removes stellar itself: the binary and ~/.config/stellar, after telling the
hub there is one install less. If your starship.toml is a symlink into
stellar's cache it is first replaced by a plain copy of the current theme,
so your prompt looks the same afterwards.
See installing for the script versions and for what stellar reports to the hub.
completion
Generates a shell completion script. See installing for setup per shell.
For the full list of flags and subcommands, run: