1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-08-17 14:55:48 +02:00
tldr/pages/common/starship.md
Martin Schorfmann 78ce83c261
starship: fix config edit command (#17319)
Correct command "starship configure" to "starship config" as of starship v1.23.0
2025-07-22 11:59:41 +02:00

37 lines
1,023 B
Markdown

# starship
> The minimal, blazing-fast, and infinitely customizable prompt for any shell.
> Some subcommands such as `init` have their own usage documentation.
> More information: <https://starship.rs>.
- Print the starship integration code for the specified shell:
`starship init {{bash|elvish|fish|ion|powershell|tcsh|zsh|nu|xonsh|cmd}}`
- Explain each part of the current prompt and show the time taken to render them:
`starship explain`
- Print the computed starship configuration (use `--default` to print default configuration instead):
`starship print-config`
- List supported modules:
`starship module --list`
- Edit the starship configuration in the default editor:
`starship config`
- Create a bug report GitHub issue pre-populated with information about the system and starship configuration:
`starship bug-report`
- Print the completion script for the specified shell:
`starship completions {{bash|elvish|fish|powershell|zsh}}`
- Display help for a subcommand:
`starship {{subcommand}} --help`