Prompt

Warp allows you to configure its default prompt or a custom prompt. A terminal prompt is a text that appears in the command line interface, indicating that the terminal is ready to accept commands.

Warp Prompt

Warp has a native prompt that is customizable and can show a variety of information including cwd, git, svn, kubernetes, pyenv, date, time, etc.

Git and Subversion

Git and Subversion context chips show which branch you are on locally, as well as the number of uncommitted changed files. This includes any new files, modified files, and deleted files that are staged or unstaged.

Kubernetes

Kubernetes context chip shows relevant information when you're using one of the following commands:

kubectl|helm|kubens|kubectx|oc|istioctl|kogito|k9s|helmfile|flux|fluxctl|stern|kubeseal|skaffold|kubent|kubecolor|cmctl|sparkctl|etcd|fubectl

Warp respects the KUBECONFIG environmental variable, make sure you set it to your preferred configuration file location, if it's not the default path of ~/.kube/config

Custom Prompt

You can also set up a custom prompt by configuring the PS1 variable or installing a supported shell prompt plugin, see Custom Prompt Compatibility Table. Note: The PS1 is a variable used by the shell to generate the prompt, it represents the primary prompt string (hence the β€œPS”) - which is what the terminal typically displays before typing new commands.

Multi-Line and Right-Sided Prompts

Warps custom prompt supports multi-line or right-sided prompts in zsh and fish, not bash. However, you can't have a multiline right-side prompt, only a multiline left prompt. You also can't have the cursor on the same line as the prompt (we're working on supporting this). Warp renders the cursor on a fresh new line within the Input Editor, a separate UI element from the prompt.

How to access it

  • Toggle the custom prompt by right-clicking on the prompt area above the input and selecting "Edit prompt" or select "Prompt" from the Settings > Appearance page. There you will be able to select and customize the default prompt or select the Custom prompt (PS1).

  • When right-clicking the prompt, you can copy the entire prompt, working directory, current git branch, etc.

How it works

Please note the installing powerlevel10k video mentions enabling a custom prompt in Settings > Features, but it's now in Settings > Appearance, see above for the updated steps.

Custom Prompt Compatibility Table

ShellToolDoes it work?

bash | zsh

Working

bash | zsh | fish

bash | zsh | fish

Working

zsh

zsh

zsh

Working

zsh

ssh

Working

bash

Not supported

bash

Not supported

bash

Not supported

bash

Not supported

bash | zsh

Not supported

zsh

Not supported

fish

fish

Known incompatibilities

If you’re having issues with prompts, please see below or our Known Issues for more troubleshooting steps. Also, although some prompts are not officially supported, they may still work in Warp.

Starship

Starship Settings

Some ~/.config/starship.toml settings are known to cause errors in Warp. # or DEL the following lines to resolve known errors:

# Get editor completions based on the config schema
'' = 'https://starship.rs/config-schema.json'

# Disables the custom module
[custom]
disabled = false

For fish shell, optional for bash|zsh, disable the multi-line prompt in Starship by putting the following in your ~/.config/starship.toml:

[line_break]
disabled = true

Starship + Bash

Starship prompt may not render properly if your default shell is /bin/bash. To workaround the issue, we recommend you upgrade bash, find the path with echo $(which bash), then put the path in your Settings > Features > Session > "Startup shell for new sessions" > Custom.

Powerlevel10k

Powerlevel10k prompt may display the arrow dividers as grey instead of color. The color for those chars is rendered grey due to Warp's minimum contrast setting, as Warp updates colors to enforce a minimum contrast ratio for readability. To workaround this issue, go to Settings > Appearance > Text > Enforce minimum contrast and set it to "Never".

Warp does support p10k version 1.19.0 and above. Make sure you have the latest version installed as well as restart Warp after the installation/update of p10k. Then enable the custom prompt as stated above and it should work.

Warp still doesn't fully support some p10k features like transient prompt and visual features like gradients.

Spaceship

This prompt can cause an issue with typeahead in Warp's input editor. To workaround the issue, run echo "SPACESHIP_PROMPT_ASYNC=FALSE" >>! ~/.zshrc.

Prezto

Although Warp does have support for prezto's prompt, enabling the prezto utility module in the .zpreztorc is not supported as with many other autocompletion plugins that are incompatible.

Disabling unsupported prompts for Warp

We advise using Warp's default prompt or installing one of the supported tools, see Compatibility Table. You can disable unsupported prompts for Warp as such:

if [[ $TERM_PROGRAM != "WarpTerminal" ]]; then
##### WHAT YOU WANT TO DISABLE FOR WARP - BELOW

    # Unsupported Custom Prompt Code

##### WHAT YOU WANT TO DISABLE FOR WARP - ABOVE
fi

iTerm2

The iTerm2 shell integration breaks Warp and your custom prompt will not be able to be visible with this on. If you're coming from iTerm2 please check your dotfiles for it. We advise disabling the integration for Warp like so:

if [[ $TERM_PROGRAM != "WarpTerminal" ]]; then
##### WHAT YOU WANT TO DISABLE FOR WARP - BELOW

test -e "${HOME}/.iterm2_shell_integration.zsh" && source "${HOME}/.iterm2_shell_integration.zsh"

##### WHAT YOU WANT TO DISABLE FOR WARP - ABOVE
fi

Last updated