Prompt
Warp allows you to configure its default prompt in addition to enabling a supported custom prompt. A terminal prompt is a text that appears in the command line interface, indicating that the terminal is ready to accept commands. The prompt can be customized to display additional information.
Warp has a native Prompt that is customizable and can show a variety of information including CWD, Git Status, Pyenv, Date, Time, etc.
Git branch that 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.
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.
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.
Edit Warp Prompt
- Toggle the custom prompt by right-clicking on the prompt area above the input and selecting "Edit prompt" or select "Prompt" from the
Settings > Appearancepage. 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 also copy the entire prompt, working directory, current git branch, etc.
Warp Prompt + Custom Prompt Demo
Shell | Tool | Does it work? |
|---|---|---|
Bash/zsh | Working | |
Bash/zsh | ||
Bash/zsh | Working | |
zsh | ||
zsh | ||
zsh | Working | |
zsh | Working | |
zsh | Not supported | |
Bash | Not supported | |
Bash/zsh | Not supported | |
fish | ||
SSH | | Working |
If you’re having issues with prompts, please see below or our Known Issues for more troubleshooting steps.
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
If you'd like to disable the multi-line prompt in starship, put the following in your ~/.config/starship.toml:
[line_break]
disabled = true
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, as noted in #3066.Warp does support p10k version 1.19.0 and above. Just make sure you have the latest version installed as well as restart Warp after the installation/update of p10k. Then enable custom prompt as stated above and it should work! Note: Warp still doesn't fully support some p10k features like transient prompt and visual features like gradients.
Installing Powerlevel10k
This prompt can cause an issue with typeahead in Warp's input editor.
To workaround the issue, run
echo "SPACESHIP_PROMPT_ASYNC=FALSE" >>! ~/.zshrcWe advise using Warp's default prompt or installing one of the supported tools, see Compatibility Table. You can disable unsupported prompts just 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
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 iTerm please check your dotfiles for it. We advise disabling the integration just 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 modified 11d ago