Mirror/git-stats
1
0
Fork 0
mirror of https://github.com/IonicaBizau/git-stats.git synced 2024-12-22 21:32:10 +01:00
Code Issues Projects Releases Packages Wiki Activity

Updated docs

Browse source
This commit is contained in:
Ionică Bizău 2016-10-23 12:05:22 +03:00
parent 1056da7a51
commit 4c2219faf3
1 changed files with 17 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -45,33 +45,35 @@ Then, run `git-stats --help` and see what the CLI tool can do.
$ git-stats --help $ git-stats --help
Usage: git-stats [options] Usage: git-stats [options]
Local git statistics including GitHub-like contributions calendars.
Options: Options:
-r, --raw Outputs a dump of the raw JSON data.
--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.
-s, --since <date> Optional start date. -s, --since <date> Optional start date.
-u, --until <date> Optional end date. -u, --until <date> Optional end date.
-n, --no-ansi Forces the tool not to use ANSI styles.
-l, --light Enables the light theme.
-a, --authors Shows a pie chart with the author related
contributions in the current repository.
-g, --global-activity Shows global activity calendar in the current -g, --global-activity Shows global activity calendar in the current
repository. repository.
-n, --no-ansi Forces the tool not to use ANSI styles.
-l, --light Enables the light theme.
-d, --data <path> Sets a custom data store file. -d, --data <path> Sets a custom data store file.
-f, --first-day <day> Sets the first day of the week. -a, --authors Shows a pie chart with the author related
--record <data> Records a new commit. Don't use this unless you contributions in the current repository.
are a mad scientist. If you are a developer, just
use this option as part of the module.
-r, --raw Outputs a dump of the raw JSON data.
-h, --help Displays this help. -h, --help Displays this help.
-v, --version Displays version information. -v, --version Displays version information.
Examples: Examples:
git-stats # Default behavior (stats in the last year) $ git-stats # Default behavior (stats in the last year)
git-stats -l # Light mode $ git-stats -l # Light mode
git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now $ git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now
git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012 $ git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012
Your commit history is kept in ~/.git-stats by default. You can create ~/.git-stats-config.json to specify different defaults. Your commit history is kept in ~/.git-stats by default. You can create
~/.git-stats-config.json to specify different defaults.
Documentation can be found at https://github.com/IonicaBizau/git-stats Documentation can be found at https://github.com/IonicaBizau/git-stats.
``` ```
## Usage ## Usage