Custom Prompt (PS1, Starship, Powerlevel10k)

[zachlloyd]

Right now we make our best guess at a useful default prompt, but don't support any customization.

The likely path forward is for us to put a nicer UI on prompt customizability and support generally useful prompt features like git status.

Another option would be to fall-back to PS1 for prompt rendering, but that would mean we'd need to support a full terminal grid in the prompt section of the input. I think we would probably only do this as a fallback, not the primary customization method.

[m50]

It looks like you use starship for the prompt? Could be wrong on this.

If so, utilize the starship configuration (~/.config/starship.toml) when rendering starship, because that's an easy win for prompt customization, easier than supporting a full custom PS1.

[zachlloyd]

We don't use starship, but using the configuration (or at least being compatible with it) is an interesting idea. Thank you for suggesting it!

…

On Wed, Aug 25, 2021 at 9:19 AM Marisa ***@***.***> wrote: It looks like you use starship for the prompt? Could be wrong on this. If so, utilize the starship configuration (~/.config/starship.toml) when rendering starship, because that's an easy win for prompt customization, easier than supporting a full custom PS1. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#96 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACCSUZN3Z7PVSSUH5ZDAKOLT6TUW5ANCNFSM5BRR7BDA> .

[binamkayastha]

This would be really nice (for me personally) as it would give me a way to customize my prompt.
Unless warp believes that there's a better format for storing prompt configuration than what starship already has, I would love compatibility out of the box.
It would be interesting to play around with representing the ux in different ways. ex. you could have badges (from material css terminology) per starship module!

The other benefit of sticking with starship is you don't have to wait for the community to re-build configurations for everything out there as you can use the ones starship already has.

[mysticaltech]

On top of that, you are both Rust projects, so very tight integration is possible! The beauty of it all is that Starship is flexible, so it already answers every need, taste, and flavor that people have and want! So just piggyback on that and be done with prompt rendering issues.

[Derpitron]

I believe tight integration with Starship would be the best thing.

Fragmentation of prompt engines and their respective ecosystems is already a big enough problem in the CLI customization space. No reason to continue that!

[Asistarz]

Can someone plz help me im trying to build kali

[TreTuna]

Custom prompt is something that I'm definitely missing a lot with Warp right now. The primary ones I've been using as of late have been Powerlevel10k and Starship (which has been taking over my prompts on most machines as of late). I would agree with @m50 here that just having Starship and using the customization from that would be amazing.

[lrvdijk]

Another point: I often use Conda (python) environments, and when you activate one, it often updates the prompt to show that it's active. Currently there's no indication of any active conda environment after conda activate your-env.

[anicholson-sq]

Yeah, not seeing the PROMPT I was expecting (also Starship) was rather jarring. It made me wonder what else from my .zshrc was being ignored/overridden.

[camerondavison]

did you figure out the answer to this? i was very shocked to not have my prompt, it did make me wonder what else is not being loaded.

[gagata]

hey! there's now a setting under features that lets you use your PS1. and regarding stuff that's not being loaded - warp pretty much loads everything that's in your rcs. PS1 is a special case - we actually have a blog post on our website describing why it's special and how we're dealing with it rn

[Asistarz]

So lost

[kaihoffman]

I also would absolutely need things from my bash PS1 to show to feel I could use Warp fully, namely my git branch and current Kubernetes context. These are currently set by scripts that show as part of the bash PS1

[yoyosource]

I am also using PS1 as a way to customize my promt and would like to see it implemented in Warp as well.

[samsrabin]

Agree, this is pretty fundamental to my workflow!

[zachlloyd]

@gagata is starting to explore solutions here. Would love all of your input as we spec things out.

[Asistarz]

I need help with kali z

[lak]

I'm also finding it jarring not to have my prompt. There's a lot of info in my prompt that isn't in this one.

It's especially useless because I don't even know what's in this prompt. Do the colors mean anything? I don't know. What systems are supported and which aren't? I don't know. The only real mention of the prompt in the docs is that you don't support PROMPT_COMMAND, and there's no mention of PS1.

[elviskahoro]

Hopefully this quarter!

[adamshaylor]

The only thing I need out of a custom prompt beyond git info is some language/framework compatibility info. That’s the only reason I still use Starship. I don’t even use the nerd fonts, which hack a proliferation of ephemeral technology icons into some ostensibly less used Unicode characters. The output cannot be rendered anywhere without that font. Plaintext output is perfectly adequate. Here’s what my Starship prompt looks like:

Perhaps a custom prompt isn’t needed at all. Warp is more than just a prompt. This compatibility info could live somewhere else in the UI, e.g. the footer like in VS Code. Its visibility could even be toggled by the user.

My point is, custom prompts are historically a first recourse for plugging holes in terminal functionality. Beyond git and language/framework info, what else do people need to know? Googling around for custom prompts, it seems like it boils down to knowing who you are (username) and where you are (directory, git status, host name/address). Why turn the prompt into a junk drawer of missing features when Warp could actually add them natively?

My input is just one anecdote, so take it with a grain of salt. I appreciate the work everyone is doing here. Terminals have been stuck decades behind modern code editors in terms of ease of use and productivity (unless you’re unusually well versed in POSIX and shell scripting). Warp is bringing the terminal into the modern age. Thank you.

[clintandrewhall]

For me, git is more than branch--

Silly emoji at the front aside, I'd like it to be customizable if only to say what git and node information is important to me in the way I want to see it. 🤷🏻

[zachlloyd]

I agree with this analysis @adamshaylor - thank you for sharing. We are trying to think through what the prompt should be from this perspective, but also balancing people's existing workflows and muscle memory.

[kaihoffman]

Beyond git and language/framework info, what else do people need to know?

Kubernetes contexts. Because they are very powerful.

[elviskahoro]

@lrvdijk - see:

• Integration: can not use conda #235

It's coming out this wednesday!

[elviskahoro]

@TreTuna @m50 @anicholson-sq Are yall in the Discord? We started speccing prompts this week and will be sharing design mockups there.
Are you watching @adamshaylor's starship issue:

• Moved to discussion #422: Support or supplant Starship modules #247

[ccpost]

I agree with @adamshaylor that Warp is an opportunity to start re-thinking the prompt as the main mechanism for showing status. I find that if I start putting everything I want to see in the prompt, it quickly becomes large and hard to parse visually. I'd love to see some basic status bar functionality as an additional choice.

That said, there is one important case where the prompt is a win over status bar widgets: historical context. Status bar widgets (at least how they exist in iTerm) only show the current state, but the prompt persists in your scrollback and can give you useful information about the context in which a command was run.

As it exists today, that would be the deciding factor for me on what to put in prompt vs a status bar. Though: maybe status bar widgets could optionally persist into scrollback? 😉

EDIT: Changed some phrasing to make the meaning clearer. (cc @lak)

[MichaelRBond]

After enabling the Honor user's custom prompt (PS1) setting. i get syntax errors whenever i enter a command.

Screenshot attached of the output.

It is a multiline prompt and i have a handful of functions, checking on various things, as part of the prompt display. Been using iterations of this prompt since the 1990s, and don't have any interest in switching it out.

I'm using PROMPT_COMMAND to set PS1

[michaelmior]

One thing that I've noticed about honoring the custom prompt is that while my prompt is a single line, Warp forces my input onto the next line anyway. I prefer a more compact prompt, so it would be nice if this were possible.

[eitanpo]

I'm using starship and PS1 enabled. The bottom prompt is mac Terminal.
There are two small issues:

1. There is a padding on the left that seems to provide no practical value
2. > is missing

[devillove084]

Still.....

[mysticaltech]

Proper support of Starship would be ideal! And since you are both Rust projects, that makes even more sense for a really tight integration.

[ygorluiz]

this issue is being caused by zsh themes, set robbyrussell as default and it will work

[AlienegraGeek]

How compatible are Warp and Starship now?

[RichardBray]

Cmd + P > Open Settings > Features > Honor user's custom prompt (PS1) setting

[andig]

It's still not sufficient to keep prompt and input on a single line, or is that intended?

[elviskahoro]

It's intended. The Prompt and Input Editor are two separate UI elements that are both native to Warp. This is what allows for having a modern text editing experience.

It's also what allows for eventually building something like this:
https://twitter.com/warpdotdev/status/1496263490491023362

[kenmorse]

Would like to see the cross-platform Oh My Posh included in the https://docs.warp.dev/features/prompt page too.

[agluck91]

It's intended. The Prompt and Input Editor are two separate UI elements that are both native to Warp. This is what allows for having a modern text editing experience.

It's also what allows for eventually building something like this: https://twitter.com/warpdotdev/status/1496263490491023362

UPDATE: I looked back at the picture to see that you all had custom option as well that you are thinking about.
This is going to be awesome. I will leave my comment below just for reference of the kinds of things that it would be nice to do. In the meantime, if it is possible easily to add a flag in the settings to toggle multiline prompt, that would be amazing while we wait for such an amazing change.

This would be really really cool, are you all planning to allow for custom chips? Otherwise I feel it would not be terribly useful for must devs. At least I would stick with starship and hope that you one day support multiline. Customizability it important to me when it comes to my prompt. I have a lot more information that I want to see than just my directory or my git branch.

For instance, I would want the ability to see the node version actively in a project that I move into. I use volta and we have many different versions pinned in different projects.

[marcbachmann]

The starship prompt is working quite well now.

One quite good feature from the warp prompt is that it removes all colors and changes to a less intrusive style for previous commands.

Would be neat if the same transformation could be used for the custom prompt. E.g. Remove all the colors & change the bold style to regular.

[forrestfwilliams]

I would love this feature as well @marcbachmann! Any update on this?

[phamann]

Has anyone worked out how to remove the additional whitespace/padding to the left of the starship prompt when enabled? As shown in the screenshot above.

[nmarch213]

You can see using the preset each symbol has a space, try going to your starship.toml file and modifying these spaces

[xzthemeofsss]

Add add_newline = false in your starship.toml file, it works for me.

[phamann]

Thanks @xzthemeofsss adding add_newline = false solved the issue for me! 🎉

[kali-lover333]

Earlier when i open terminal in kali the title bar of terminal shows kali now shell no 1 shows up.
And my username and machine name didn't show up, just a simple black interface when i press ctrl C
then the shell name change to kali@kali and i can see my username . but why plz anybuddy knows how
to fix the problem even i cant see my history and even i didnt delete my history.

[elviskahoro]

Are you in SSH or a subshell? Can you send a video?

[kali-lover333]

dear bro i solve a problem but now i have another problem in my terminal . storm breaker is not installing while i watch a video on youtube and i copy link from youtube and github but both are not working . m gonna send screen shot plz help me m totally newbie thanks

[kali-lover333]

bro plz check what is the problem and teach me to solve problem

[qazi0]

bro plz check what is the problem and teach me to solve problem

@kali-lover333 This seems completely unrelated to warp or starship. You should ask this on StackOverflow, I hear they are very welcoming towards newbie questions ;~)

[kali-lover333]

@Siraj-Qazi bhai jan ap islamabad say ho ?

[dannyneira]

Hi Folks, We're working on powerlevel10k (p10k) support with the maintainer, and you can track the progress here: #2851

No official ETA, but we should have some updates in the coming weeks.

[AkshayKumar007]

Hi Team Warp, first of all thank for creating such a great tool. I had a small query regarding custom-prompts. Is there a way to disable the extra newline character that is being added to prompt by warp? I couln't find anything about this in docs

[elviskahoro]

hey @AkshayKumar007
We're not adding the newline character; before the update we were ignoring it (not honoring it). You can disable it by adding this to your starship config:

[line_break]
disabled = true

[AkshayKumar007]

Hi @elviskahoro , thanks for the revert. Actually I'm not using starship. I'm just using the default zsh shell I had setup using oh-my-zsh.

[madorb]

i'm seeing an extra newline with powerline10k.

Warp:

iterm:

[marc-brouard]

Seeing this also with starship prompt

In warp

in Alacritty

[rhmnaulia]

Has this issue already been resolved?

[samkrishna]

Hi Team Warp -- I'm currently using the BulletTrain git prompt within iTerm2+zsh. Using the Dark theme in Warp badly mangles the colors and makes the prompt hard-to-read. Here's an example:

As you can see, the above iTerm2 shell window is overlapping the Warp window with the Dark theme. I'm expecting (hoping?) for colors similar to my iTerm2 window. Or at least some way to granularly-customize the display colors to get something close to my iTerm2 experience.

LMK if you need something more or require any follow-up.

[Asistarz]

Can I get some help plz im trying to build kali 1srt time

[dylansavage]

It looks like p10k SHOW_ON_COMMAND is not implemented correctly.

It is working with iterm2 but needed to turn it off in Warp.

[heylookltsme]

Hey friends, hoping someone can help out. I'm using starship with warp and I've already fixed a couple issues by adding the following to my starship config -

add_newline = false

[line_break]
disabled = true

But I'm still dealing with pesky empty vertical space between the prompt and my cursor -

Anyone know how I can get rid of this? Many thanks!

[elviskahoro]

are you using another plugin? a syntax highlighting plugin by chance?

[heylookltsme]

Nope, nothing like that 🤔

[advait-m]

Hey! Hmm, thanks for raising - could you please share your full starship.toml (want to see if I can reproduce this and help with resolving it)?

[heylookltsme]

I figured it out! It's the fill module. When I remove fill, then that vertical space disappears.

I use fill to align the time module to the right side. Other than the vertical space, this alignment seems to work fine in Warp.

Here's the same starship configuration in iTerm:

And Warp:

Is this something the team is already aware of? Would it be helpful if I opened a ticket?

[advait-m]

Ah - thanks for digging into this and for the additional context. Don't believe we're tracking this currently - yep, would love it if you opened a GitHub issue for this @heylookltsme ! Thanks!

Note - we do support RPROMPT in Warp, which is another way to right-align items correctly (with a lprompt + rprompt setup). We support this in zsh and fish - see https://docs.warp.dev/appearance/prompt#multi-line-and-right-sided-prompts