Skip to content

hv15/gitstatusd-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

Gitstatusd plugin for Oh-My-{Ba,Z}sh

Add support for the gitstatus tool in both Oh-My-Bash and Oh-My-Zsh. The gitstatus makes polling for git repository status much faster, reducing lag on updating the shell prompt.

The plugin, called gitstatusd, overrides the git_prompt_info function provided by either framework, effectively changing which tool is used to poll for git repository information.

This has been tested with Oh-My-Zsh's tjkirch theme.

Setup

The plugin depends on gitstatus, and expects it to be installed system-wide. Follow the install instructions of gitstatus.

To use the plugin, clone this repository into the customs/plugins/ directory of the frameworks top-dir. After this, updated the RC to use the plugin. Start a new shell and enjoy!

Todo

The plugin is currently very limited, implementing only the most basic support.

  • implement most (all?) function in the lib/git.{zsh,sh} file, making gitstatus implicitly available for all themes.
  • add support for beautifying the git prompt (maybe this is something for themes to do, not a plugin?)
  • implement tests/CI to make sure this works for a variety of setups.