Awesome

Clover

🍀 a configurable theme for zsh, inspired by zeta-zsh-theme and pure.

• Highlights environment changes

  Username and host changes the style for special environments: root, remote, container

• Async VCS status

  Background process, don't blocks your workflow

• Execution time

  Show human readable execution time for long run command

• Python

  Virtualenv prompt is included

• Show the error

  Prompt indicator changes whether the last run success (🍀/🔥)

• Configurable

  Read the configuration section below

Installation

oh-my-zsh

clone this repo into $ZSH_CUSTOM:

cd ${ZSH_CUSTOM:-"~/.oh-my-zsh/custom"}/themes
git clone git@github.com:tzing/clover.zsh-theme.git clover

then change the theme:

ZSH_THEME="clover/clover"

zinit

zinit light tzing/clover.zsh-theme

Manual

clone this repo to somewhere you like:

git clone git@github.com:tzing/clover.zsh-theme.git <PATH>

and source the main script in your .zshrc

source <PATH>/clover.zsh-theme

Configurations

This theme reads the configurations from zstyle. All context name must be prefixed with :prompt:clover:. Styles are always configurable, and for some components you could also customized the symbols.

Here's a disgram that shows context names:

   ┌---------------------------------------------------------------------- user
   |    ┌----------------------------------------------------------------- host
   |    |         ┌------------------------------------------------------- path
   |    |         |                   ┌----------------------------------- vcs:branch
   |    |         |                   |    ┌------------------------------ vcs:status (read details below)
   |    |         |                   |    |          ┌------------------- execution-time
   |    |         |                   |    |          |    ┌-------------- current-time
#  user@hostname: ~/clover.zsh-theme <main ✔⇡>        10s (12:00:00 +0800)
(.venv) 🍀
 |      └----------------------------------------------------------------- prompt
 └------------------------------------------------------------------------ virtualenv

[!NOTE]

VCS information (:prompt:clover:vcs:*) are evaluated in background process, which is forked in first precmd run. Runtime zstyle settings will not take effect. But you could still change the style in .zshrc.

Styles

Run zstyle command with the key style. And the value could be the visual effect expresssion in zsh prompt expansion.

An example of setting the path to bold cyan:

zstyle :prompt:clover:path style '%B%F{cyan}'

Symbols

Use key symbol for customization.

For example, setting default prompt symbol to $:

zstyle :prompt:clover:prompt:default symbol '$'

Contexts and default styles

Others

There are some other settings could be changed through zstyle too: