GitHub Spray

![license]()

A CLI to generate sprays for your GitHub contribution history graph


Installation

``sh
npm i -g github-spray
`

Requirements

- Git
- Recent NodeJS

Usage

1. Create a new GitHub repository and copy its url
2.
`sh
github-spray -t --multiplier --push --origin
`
(example)
`sh
github-spray -t hello --multiplier 10 --push --origin https://github.com/John/hello.git
`
_Depending on your number of contributions on the given period that you want to spray, you will need to multiply the number of commit per day by a specific factor (--multiplier) so that the spray become more relevant on your calendar heatmap_.

`sh
github-spray --help
`

$3


`sh
github-spray -t --font
`
(example)
`sh
github-spray -t Wald0 --font portable_vengeance
`
![](https://i.imgur.com/iF2xwwU.png)
`sh
github-spray -t Mario? --font mario
`
#### led7
Fonts available are in the fonts folder

$3

`sh
github-spray -t hello -i
`

$3

`sh
github-spray -t hello --flipvertical
`

$3

`sh
github-spray -t hello --fliphorizontal
`

$3

To use a custom pattern, create a JSON file like follow.
The numbers (1 to 4) will determine the number of commit per day, and thus the green's darkness.
`json
[
" 333 ",
" 3 3 ",
"3 2 2 3",
"3 3",
"3 222 3",
" 3 3 ",
" 333 "
]
`
![](https://i.imgur.com/sZDSnFH.png)
`sh
github-spray -f ...
`

![](https://i.imgur.com/QDxcot7.png)
`sh
github-spray -f patterns/space-invaders.json ...
`

You can use GitHub Spray Generator to graphically draw patterns

$3


`sh
github-spray --startdate YYYY-MM-DD ...
`
The date will be rounded to the nearest sunday.
By default the start date is the nearest sunday of the current date - 53 weeks.

$3

`sh
github-spray -m ...
``
Multiply the number of commit per day by the given factor to make the spray darker or brighter on your calendar heatmap.

Known issues

- Before Monday 10 March 2014 there could be a shift due to the timezone