git-stats/bin/docs/help

29 lines
1.1 KiB
Plaintext
Raw Normal View History

2015-01-30 14:14:28 +01:00
git-stats --help
A GitHub-like contributions calendar, but locally, with all your git commits.
2015-02-09 13:36:35 +01:00
usage: git-stats [start] [end] [options] [data]
start: Optional start date
end: Optional end date
2015-01-30 14:14:28 +01:00
options:
-v Displays version information.
-h --help Displays this help.
--no-ansi Doesn't use ANSI colors in the squares.
--record <data> Records a new commit. Don't use this unless you are
a mad scientist. If you are a developer, just use this
option as part of the module.
2015-02-01 14:28:35 +01:00
--light Enable the light theme.
2015-01-30 14:14:28 +01:00
examples:
git-stats # Displays your commit calendar
git-stats -v
git-stats -h
2015-02-01 14:28:35 +01:00
git-stats --light # Light mode
2015-02-09 13:36:35 +01:00
git-stats '1 January 2012' # All the commits from 1 January 2012, to now
git-stats '1 January 2012' '31 December 2012' # All the commits from 2012
2015-01-30 14:14:28 +01:00
Your commit history is keept in the .git-stats, in your $HOME directory (~/)
Documentation can be found at https://github.com/IonicaBizau/git-stats