FAQ

What is the configuration used in the demo GIF?

Do prompt_order and <module>.disabled do the same thing?

Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, <module>.disabled is the preferred way to do so for these reasons:

  • Disabling modules is more explicit than omitting them from the prompt_order
  • Newly created modules will be added to the prompt as Starship is updated

The docs say Starship is cross-shell, but it doesn't support X shell. Why?

The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used.

Here's a small example getting Starship working with bash:

# Get the status code from the last command executed
STATUS=$?

# Get the number of jobs running.
NUM_JOBS=$(jobs -p | wc -l)

# Set the prompt to the output of `starship prompt`
PS1="$(starship prompt --status=$STATUS --jobs=NUM_JOBS)"

The Bash implementation built into Starship is slightly more complex to allow for advanced features like the Command Duration module and to ensure that Starship is compatible with pre-installed Bash configurations.

For a list of all flags accepted by starship prompt, use the following command:

starship prompt --version

The prompt will use as much context as is provided, but no flags are "required".