A custom zsh prompt expander written in rust.
Shibuichi handles a superset of zsh prompt expansions. Standard zsh prompt expansions are left alone, and this just adds several other expansions, substituting them on the fly:
%r - The short name of the current git branch. If not in a git repository
this will be empty.%p - An integer for the number of commits the current branch is ahead of
its remote tracking branch. If there is no remote tracking branch, this will
render as a 0.%q - An integer for the number of commits the current branch is behind
of its remote tracking branch. If there is no remote tracking branch, this
will render as a 0.%x - An integer for the number of current stashes.
In addition, this also adds a few more codes to the conditional substring expansion
%(x.true-text.false-text). These codes are:
G - True if in a git repository.
y - True if the git repository is dirty.m - True if the git repository has modified files.s - True if the git repository has staged files.o - True if the domain of the remote tracking origin number matches n,
where 0 is reserved for all other domains:
github.comgitlab.combitbucket.orgdev.azure.comp - True if the remote tracking branch is at least n commits ahead of
the current branch.q - True if the remote tracking branch is at least n commits behind of
the current branch.x - True if there are at least n stashes.
cargo install shibuichi
Replace your zsh PROMPT precmd by processing it with shibuichi first.
This then allows you to use the expanded escape sequences.
For example:
precmd() {
PROMPT="$(shibuichi ' %r %# ')"
}
creates a simple prompt that shows your git branch.
My current prompt is:
%F{white}%K{black}%(?.%1(j. .). %1(j..) ) %n@%m %F{black}%K{blue}%F{black} %~ %F{blue}%(G.%(y.%K{yellow}.%K{green})%F{black} %0(o..)%1(o..)%2(o..)%3(o..)%4(o.ﴃ.)%1(p. .%1(q. .%1(x. .)))%1(p.%2(p.%3(p.%p.).).)%1(q.%2(q.%3(q.%q.).).)%1(x.%2(x.%3(x.%x.).).) %r%(m. .%(s. .))%(m..)%(s..) %(y.%F{yellow}.%F{green}).)%k%f
This was designed to be as agnostic to prompt style as possible. In particular, this shouldn't make any choices about layout preferences, and instead seek to provide manipulable output.
Shibuichi is an alloy of silver and copper because this was inspired by silver.