Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.8 KB

README.md

File metadata and controls

68 lines (51 loc) · 2.8 KB

GH Candle 🕯️

If you had to create one or more separate GitHub accounts that reflect most of your activity, and now your personal GH contribution graph looks quite sad... Say no more! There is a way to "synchronize" those activities with GH candle 🕯️.

GH Contribution Graph transformation

Note: There is no official way to fully synchronize GH contribution graphs, and this tool is no exception to that fact. Instead GH candle 🕯️ projects other GH profiles' activity into yours, you guessed it, like shadow puppets cast by your hands in front of a candle.

Make it run 🔥

You could clone this repository then run the script locally like this

GH_TOKEN=XXXXXX ./light-on.sh my-second-github-account

Or you could inmediately execute it right after you fetch it from internet, like this

export GH_TOKEN=XXXXXX
curl -sfL https://raw.githubusercontent.com/jossemarGT/gh-candle/master/light-on.sh | sh -s my-second-github-account

Prerequisites 🔔

GH candle should work as long you have the following setup in your machine:

When in doubt use -h

$ ./light-on.sh -h
usage: ./light-on.sh [-b <git branch>] [-g <git path>] [-d] [-h] <GitHub handle>
  -g    set local git repository for activity shadowing. Default: '.'
  -b    set local git branch for activity shadowing. Default: 'shadow/<GitHub handle>'
  -k    skip initializing git repository
  -d    dry-run
  -h    show help

environment variables overrides:
  GH_TOKEN   - GH Personal access token used for GH API lookups. Fails when empty.
  DATE_START - GH graph to be synced start date. Uses "a year ago" when empty.
  DATE_END   - GH graph to be synced end date. Uses "today" when empty.
  DEBUG      - When set, prints out debug messages

examples:
  GH_TOKEN='xxxxxx' ./light-on.sh octocat

Colophon