https://github.com/zimfw/steeef

A customizable version of steeef's prompt theme.
https://github.com/zimfw/steeef

prompt theme zim zimfw zsh zsh-plugin zsh-plugins zsh-prompt zsh-theme

Last synced: 4 months ago
JSON representation

A customizable version of steeef's prompt theme.

• Host: GitHub
• URL: https://github.com/zimfw/steeef
• Owner: zimfw
• License: mit
• Created: 2018-12-26T14:35:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-13T16:50:30.000Z (over 3 years ago)
• Last Synced: 2025-04-13T12:13:13.013Z (7 months ago)
• Topics: prompt, theme, zim, zimfw, zsh, zsh-plugin, zsh-plugins, zsh-prompt, zsh-theme
• Language: Shell
• Homepage:
• Size: 18.6 KB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zsh-plugins - steef (zimfw) - A customizable version of [steeef's](https://github.com/ohmyzsh/ohmyzsh/blob/master/themes/steeef.zsh-theme) theme. (Themes / ZSH on Windows)
• fucking-awesome-zsh-plugins - steef (zimfw) - A customizable version of <b><code>182719⭐</code></b> <b><code>&nbsp;26276🍴</code></b> [steeef's](https://github.com/ohmyzsh/ohmyzsh/blob/master/themes/steeef.zsh-theme)) theme. (Themes / ZSH on Windows)
• awesome-zsh-plugins - steef (zimfw) - A customizable version of [steeef's](https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/steeef.zsh-theme) theme. (Themes / Zinit (née zplugin))

README

          
steeef

======

A customizable version of [steeef's] theme.



What does it show?

------------------

  * "`user` at `hostname` in `working directory`"

  * Git branch name, or commit short hash when in ['detached HEAD' state].

    Also, unindexed, indexed, and untracked indicators, and an optional stashed

    indicator (must be customized, see below).

  * Python [venv] indicator.

Settings

--------

This theme can be customized with the following environment variables. If the

variable is not defined, the respective default value is used. There are default

colors for 256-color terminals (or otherwise).

| Variable        | Description             | Default value    |

| --------------- | ----------------------- | ---------------- |

| USER_COLOR      | User name color         | 135 (or magenta) |

| HOST_COLOR      | Host name color         | 166 (or yellow)  |

| PWD_COLOR       | Working directory color | 118 (or green)   |

| BRANCH_COLOR    | Git branch name color   | 81 (or cyan)     |

| UNINDEXED_COLOR | Git unindexed color     | 166 (or yellow)  |

| UNINDEXED_IND   | Git unindexed indicator | ●                |

| INDEXED_COLOR   | Git indexed color       | 118 (or green)   |

| INDEXED_IND     | Git indexed indicator   | ●                |

| UNTRACKED_COLOR | Git untracked color     | 161 (or red)     |

| UNTRACKED_IND   | Git untracked indicator | ●                |

| STASHED_COLOR   | Git stashed color       |                  |

| STASHED_IND     | Git stashed indicator   |                  |

The git stashed indicator will not be shown unless defined.

Requirements

------------

Requires Zim's [git-info] module to show git information.

[steeef's]: https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/steeef.zsh-theme

['detached HEAD' state]: https://git-scm.com/docs/git-checkout#_detached_head

[venv]: https://docs.python.org/3/library/venv.html

[git-info]: https://github.com/zimfw/git-info