Skip to content

About

GitHub contribution streak and statistic tracking command line application with ASCII contribution graph

Topics

Resources

Stars

13 stars

Watchers

1 watching

Forks

Repository files navigation

Streaker CLI

GitHub contribution streak and statistic tracking command line application with ASCII contribution graph

ci downloads version license

Installation

npm install -g streaker

Usage

streaker <username> [options]

Options

Option Description Default
-a, --accent <color> Accent color for the icon, headings and graph green
-g, --graph Show the contribution graph instead of stats
--no-icon Hide the octocat icon
--no-streak Hide streak stats
--no-contributions Hide contribution stats
-V, --version Print the version
-h, --help Show help

Accent colors: red, green, yellow, blue, magenta, cyan, white, a bright- variant of each (e.g. bright-magenta), or rainbow to cycle through them. Colors come from your terminal's own palette, so they follow your theme. Set NO_COLOR=1 to disable color.

Stats

Display the octocat, streak stats and contribution stats side by side:

$ streaker jamieweavis

   ██▄▄▄▄▄▄██     streak            contributions
  ███▀▀▀▀▀▀███    current      3    today      17
  ██  █  █  ██    best        35    most       52
   ▀▀▄▄▄▄▄▄▀▀     previous     8    total    2110

Segments

Each segment is shown by default. Hide any of them with --no-<segment>:

$ streaker jamieweavis --no-icon --no-contributions

  streak
  current      3
  best        35
  previous     8

Accent color

Pick from terminal colors: red, green, yellow, blue, magenta, cyan, white, a bright- variant of each (e.g. bright-magenta), or rainbow.

$ streaker jamieweavis --accent magenta

Graph

Display the ASCII contribution graph for the past year:

$ streaker jamieweavis --graph

     Oct Nov  Dec Jan Feb Mar  Apr May  Jun Jul Aug  Sep Oct
    ┌──────────────────────────────────────────────────────
Sun │    ▒               ░           ▒░    ░░░░░  ▒ █░▒░█▒
Mon │  ▒█ ░░  ░░░ ░░░  ░ ░▒░▓░░▓ ░ ░ ▓░ ▒░░▒░█▒▒░░░ ▒ █░▒░
Tue │  ▒▒▒░░ ░░▒  ░░  ░░ ▒░░░░░░ ░░░ ▒░░░░░░░▓░▓▒▓░▒░ ▓▒ █░
Wed │  ▒░░░░ ░░▒░  ░░  ░░░░░█░░░ ░ ░░░▓░▒░░░█▓░▒▒░▓░░ ▓█▒▓░
Thu │ ░░░░░░ ░▒░░   ░  ░░▒▒▒░░█   ░ ▓█▒░▒ ░▓▒░▓▒▒▒▒ ▓ █▒░░▒
Fri │ ░░▒░░  ░░ ░       ░▒░░▒░▒  ░  █░░  ░░▒▓▒▒░░░░▒░ ░░ ░
Sat │ ░░▒               ░  ▒         ░ ▒   ░█▒▒▒░░ ▓░▒▓ ░░
    └──────────────────────────────────────────────────────

The accent applies to the graph too:

$ streaker jamieweavis --graph --accent blue

Related

  • Streaker - Cross-platform GitHub contribution streak and statistic tracking menu bar application with reminder notification
  • Contribution - GitHub contribution graph parser calculates contribution streak and commit statistics from a user's GitHub contribution graph page

About

GitHub contribution streak and statistic tracking command line application with ASCII contribution graph

Topics

Resources

Stars

13 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages