Forrest logo
tool overview
On this page you find all important commands for the CLI tool starship. If the command you are looking for is missing please ask our AI.

starship

Starship is a customizable command line tool aimed at enhancing the command prompt experience. It provides a minimalist and fast shell prompt for Unix-based systems, such as Linux, macOS, and Windows.

  1. Starship replaces the traditional shell prompt with a highly customizable and informative prompt.
  2. It supports various shells, including Bash, Zsh, Fish, and PowerShell.
  3. The tool is designed to be lightweight and efficient, ensuring a fast prompt display.
  4. Starship offers a wide range of features, such as displaying the current directory, Git branch and status, package version information, and custom icons.
  5. It supports various symbols and emojis to make the prompt visually appealing and easier to understand.
  6. Starship allows users to customize the prompt layout, colors, and symbols using a simple configuration file.
  7. The tool provides built-in support for many popular tools and programming languages, including Rust, Node.js, Python, Go, and Docker.
  8. Starship displays information about the last command's execution time for improved efficiency tracking.
  9. It supports displaying environment variables, hostnames, and usernames in the prompt.
  10. Starship has a vibrant and active open-source community, which contributes to its continuous improvement and integration with various command line tools.

List of commands for starship:

  • starship-init:tldr:007b1 starship-init: Append the `starship` integration code to `~/.bashrc`.
    $ starship init ${bash} >> ${~--bashrc}
    try on your machine
    explain this command
  • starship-init:tldr:28c3f starship-init: Display the subcommand help.
    $ starship init --help
    try on your machine
    explain this command
  • starship-init:tldr:3b582 starship-init: Print the starship integration code for the specified shell.
    $ starship init ${select}
    try on your machine
    explain this command
  • starship:tldr:05092 starship: Create a bug report GitHub issue pre-populated with information about the system and starship configuration.
    $ starship bug-report
    try on your machine
    explain this command
  • starship:tldr:0ef8e starship: Explain each part of the current prompt and show the time taken to render them.
    $ starship explain
    try on your machine
    explain this command
  • starship:tldr:1c640 starship: Display help for a subcommand.
    $ starship ${subcommand} --help
    try on your machine
    explain this command
  • starship:tldr:692de starship: Edit the starship configuration in the default editor.
    $ starship configure
    try on your machine
    explain this command
  • starship:tldr:81dd0 starship: Print the computed starship configuration (use `--default` to print default configuration instead).
    $ starship print-config
    try on your machine
    explain this command
  • starship:tldr:b449c starship: Print the completion script for the specified shell.
    $ starship completions ${select}
    try on your machine
    explain this command
  • starship:tldr:c9593 starship: List supported modules.
    $ starship module --list
    try on your machine
    explain this command
tool overview