/ 
App-Git-Spark-0.003
River stage zero No dependents
/ App::Git::Spark

NAME

App::Git::Spark - Plot your git commit history on the command line with sparklines

SYNOPSIS

⚡ git spark --days 14 --scale 23 Stegosaurus
Commits by Stegosaurus over the last 14 days
total: 95   avg: 7   max: 23
10 15 6 23 5 0 0 1 15 0 17 3 0 0
▄▅▂█▂▁▁▁▅▁▆▁▁▁

⚡ git spark --days 14 --scale 23 Triceratops
Commits by Triceratops over the last 14 days
total: 90   avg: 7   max: 22
1 12 3 11 3 0 0 6 16 3 13 22 0 0
▁▄▁▄▁▁▁▂▅▁▄▇▁▁

⚡ git spark -h
usage: git spark [-dhmoswy] [long options...] [AUTHOR]
        -o --hours      Commits from the last x hours
        -d --days       Commits from the last x days
        -w --weeks      Commits from the last x weeks
        -m --months     Commits from the last x months
        -y --years      Commits from the last x years
        -s --scale      Set the max value of the graph. Use this option to
                        compare this graph with other graphs.
        -h --help       Show this message

DESCRIPTION

Plot your git commit history on the commandline with sparklines. This is a mashup of git, spark, and Perl.

COMPARING GRAPHS

Unfortunately you often cannot compare `spark` output because the scaling is relative. For example these two data series produce identical graphs despite have very different data.

⚡ spark 1 2 3 4 5
▁▂▄▆█
⚡ spark 10 20 30 40 50
▁▂▄▆█

To solve this, you must put a max and a min in front of the data to get consistent scaling. For example:

⚡ spark 50 1 1 2 3 4 5
█▁▁▁▁▁▁
⚡ spark 50 1 10 20 30 40 50
█▁▂▃▅▆█

git-spark assumes the min is zero and users can pass in the max using the --scale option. (Note that git-spark chops off the max/min characters from the output so this is all hidden behind the scenes.)

INSTALLATION

First, download spark and put it somewhere in your $PATH. (TODO: Include spark in this distro.)

Next, install git-spark with cpanm. cpanm is the standard tool the Perl community uses to download and install Perl libraries from the CPAN. The following should get you up and running quickly:

curl -L http://cpanmin.us | perl - --sudo App::cpanminus
cpanm App::Git::Spark

AUTHOR

Eric Johnson <cpan at iijo dot nospamthanks dot org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Eric Johnson.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.