Prism grows Github streak with your private repository commits. It works like prism (glass).
Before you use, following tasks must be completed.
- Specify your favorite directory for storing prism task files as
export ZSH_PLUGIN_PRISM_PATH=${HOME}/.prism
in your.zshenv
- Specify your favorite log store repository as
export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=prism_hub
in your.zshenv
# .zshenv (Example)
export ZSH_PLUGIN_PRISM_PATH=${HOME}/.prism
export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=prism_hub
- Create directory
ZSH_PLUGIN_PRISM_PATH
- Make hub repository
ZSH_PLUGIN_PRISM_HUB_REPOSITORY
in Github, and clone it intoZSH_PLUGIN_PRISM_PATH
(or do it manually) - Initialize hub repository with empty file named
log
- Add one-line
export ZSH_PLUGIN_PRISM_HUB_REPOSITORY=${HOME}/.prism/prism_hub
into your.zshenv
- Add hook in your
.zshrc
as follows
# .zshrc
FPATH=path/to/prism/src:$FPATH
autoload -Uz prism
function prism-preexec() { prism --preexec $* }
function prism-precmd() { prism --precmd }
add-zsh-hook preexec prism-preexec
add-zsh-hook precmd prism-precmd
Before you use, you must register your project for target of observation
- In your repository, run
prism -a
for register your repository
- In your repository, run
prism -d
for un-register your repository
- You must push repository information to Github.
prism --push
This plugin wants to use variable ZSH_PLUGIN_PRISM_COMMIT_FLAG
for checking of commit status.
Please do not make conflicts.
See LICENSE
.
Now, this projcet needs more options, bug-fixing, support Antigen etc.