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 downloaded themes you're not using
stellar remove	Remove one or more cached themes
stellar rollback	Switch back to the previously applied theme
stellar new	Create a new, empty theme of your own
stellar fork	Copy a theme into one you own, to edit freely
stellar publish	Upload a local theme (or a new version) to the hub
stellar auth	Log in to the hub, check the login, or log out
stellar update	Update 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.

Editing the cached config file after applying it, and what happens when you later apply a newer version, is covered in Customizing an applied theme.

preview

Opens a new terminal window with the theme applied, without changing your active config.

list

Lists all themes currently cached locally, one line per theme with its versions, newest first.

current

Shows which theme is currently applied.

info

Shows metadata for a theme, such as its description and available versions.

clean

Removes themes stellar downloaded from the hub that you're not currently using, freeing up space in ~/.config/stellar/. Your own themes - the ones you made by hand or with new and fork - stay, and so do the theme you have applied and your backups.

clean never removes the version you have applied (except with --all, duh), so it's safe to run while you have local edits in the active theme's file - see Customizing an applied theme. Backups are never removed by clean, whatever the flags - only stellar remove <username>/backup deletes them.

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 - that protection covers any local edits you've made to it too, see Customizing an applied theme. Pass --force (or -f) when you mean it.

rollback

Switches back to whichever theme was applied before the current one.

new

Creates a theme of your own with a small starter config, at ~/.config/stellar/<you>/<name>/1.0.toml. Never overwrites an existing file.

fork

Copies a theme from the hub (or from your cache, when offline) into one you own, with a line crediting the original at the top.

Like apply, fork asks before copying a theme that contains [custom] commands; --force (or -f) skips that question.

Themes made with new and fork are kept by stellar clean - only stellar clean --include-own removes them, after asking.

publish

Uploads a local theme to the hub as a draft and prints a link to finish it in the browser - or publishes it right away with --publish. Already published? Then it starts the next version instead.

Every flag, drafts and new versions are covered in Publishing.

auth

Logs the CLI in to the hub through your browser - publish needs it.

See Publishing for what the login can do and how to revoke it.

update

Updates the stellar-cli binary itself to the latest release.

uninstall

Removes stellar itself: the binary and ~/.config/stellar. 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. Before it asks for confirmation, it lists your own themes and backups, since those go too.

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:

Next steps

# Uses the latest local version, or downloads the latest version if not cached
stellar apply a3chron/ctp-blue

# Apply a specific version
stellar apply a3chron/ctp-blue@1.2

# Check for updates and download if available
stellar apply a3chron/ctp-blue --update

# Apply without being asked to confirm custom shell commands
stellar apply a3chron/ctp-blue --force

stellar preview a3chron/ctp-red

stellar list

stellar current

stellar info a3chron/ctp-green

stellar clean

# Also remove your own themes (asks first)
stellar clean --include-own

# ...without asking
stellar clean --include-own --yes

# Also remove the currently applied theme
stellar clean --all

# Remove all versions of a theme
stellar remove a3chron/ctp-green

# Remove a specific version only
stellar remove a3chron/ctp-green@1.0

# Remove multiple themes at once
stellar remove a3chron/ctp-green a3chron/ctp-red

# Remove a theme even though it's the one currently applied
stellar remove a3chron/ctp-green --force

stellar rollback

stellar new my-theme

# Under a specific author folder
stellar new a3chron/my-theme

stellar fork a3chron/ctp-blue cozy-blue

# Fork a specific version
stellar fork a3chron/ctp-blue@1.2 cozy-blue

# Fork without being asked to confirm custom shell commands
stellar fork a3chron/ctp-blue cozy-blue --force

stellar publish my-theme

# A file or a folder works too
stellar publish ./starship.toml --slug my-theme

# Skip the browser
stellar publish my-theme --publish --screenshot ./prompt.png

stellar auth          # log in
stellar auth status   # show who you're logged in as
stellar auth logout   # revoke this login

stellar update

stellar uninstall

# Keep ~/.config/stellar (cache, backups and config) around
stellar uninstall --keep-config

# Don't ask for confirmation
stellar uninstall --yes

stellar completion bash

stellar --help