https://github.com/Annihil/github-spray
:octocat: Draw on your GitHub contribution graph ░▒▓█
https://github.com/Annihil/github-spray
calendar cli cli-app contribution github graffiti graph heatmap javascript npm-package pixel-art
Last synced: 11 days ago
JSON representation
:octocat: Draw on your GitHub contribution graph ░▒▓█
- Host: GitHub
- URL: https://github.com/Annihil/github-spray
- Owner: Annihil
- License: mit
- Created: 2019-01-20T23:35:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-09T13:02:17.000Z (over 1 year ago)
- Last Synced: 2025-03-31T14:11:14.499Z (15 days ago)
- Topics: calendar, cli, cli-app, contribution, github, graffiti, graph, heatmap, javascript, npm-package, pixel-art
- Language: JavaScript
- Homepage: https://annihil.github.io/github-spray-generator
- Size: 30.3 KB
- Stars: 1,385
- Watchers: 17
- Forks: 85
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-profile - GitHub Spray
README
# GitHub Spray
[](https://www.npmjs.com/package/github-spray)
[]()
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
```
### Fonts
```sh
github-spray -t --font
```
(example)
```sh
github-spray -t Wald0 --font portable_vengeance
```
```sh
github-spray -t Mario? --font mario
```
#### led7
*Fonts available are in the fonts folder*
### Invert colors
```sh
github-spray -t hello -i
```
### Flip vertical
```sh
github-spray -t hello --flipvertical
```
### Flip horizontal
```sh
github-spray -t hello --fliphorizontal
```
### Custom pattern
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 "
]
```
```sh
github-spray -f ...
```
```sh
github-spray -f patterns/space-invaders.json ...
```
**You can use [GitHub Spray Generator](https://annihil.github.io/github-spray-generator/) to graphically draw patterns**
### Custom start date
```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.
### Multiplier: scale colors
```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](https://github.blog/2014-03-07-timezone-aware-contribution-graphs/)