https://github.com/zimfw/gitster

A fork of shashankmehta's gitster prompt theme.
https://github.com/zimfw/gitster

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

Last synced: about 2 months ago
JSON representation

A fork of shashankmehta's gitster prompt theme.

• Host: GitHub
• URL: https://github.com/zimfw/gitster
• Owner: zimfw
• License: mit
• Created: 2018-12-27T19:06:24.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-17T17:39:28.000Z (about 1 year ago)
• Last Synced: 2024-04-20T18:01:21.830Z (9 months ago)
• Topics: gitster, prompt, theme, zim, zimfw, zsh, zsh-plugin, zsh-plugins, zsh-prompt, zsh-theme
• Language: Shell
• Homepage:
• Size: 17.6 KB
• Stars: 4
• Watchers: 3
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
gitster

=======

A fork of shashankmehta's [gitster] theme.



What does it show?

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

  * Red `➜` when last command failed, green otherwise.

  * Current working directory, relative to the git root when in a git repo.

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

  * Yellow `✗` when in a dirty git working tree, green `✓` when in a clean one.

Advanced settings

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

You can customize how the current working directory is shown with the

[prompt-pwd module settings].

The git indicators can be customized by changing the following git-info module

context formats:

| Context name | Description       | Default format      |

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

| branch       | Branch name       | `%b`                |

| commit       | Commit short hash | `%c`                |

| clean        | Clean state       | `%F{green}%{%G✓%}`  |

| dirty        | Dirty state       | `%F{yellow}%{%G✗%}` |

Use the following command to override a git-info context format:

    zstyle ':zim:git-info:' format ''

For detailed information about these and other git-info settings, check the

[git-info documentation].

These advanced settings must be overridden after the theme is initialized.

Requirements

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

Requires Zim's [prompt-pwd] module to show the current working directory, and

[git-info] to show git information.

[gitster]: https://github.com/shashankmehta/dotfiles/blob/master/thesetup/zsh/.oh-my-zsh/custom/themes/gitster.zsh-theme

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

[prompt-pwd module settings]: https://github.com/zimfw/prompt-pwd/blob/master/README.md#settings

[git-info documentation]: https://github.com/zimfw/git-info/blob/master/README.md#settings

[prompt-pwd]: https://github.com/zimfw/prompt-pwd

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