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: 7 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 (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-09T13:02:17.000Z (11 months ago)
• Last Synced: 2024-10-29T17:55:57.430Z (13 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,348
• Watchers: 18
• Forks: 76
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-profile - GitHub Spray

README

        
# GitHub Spray

[![npm](https://img.shields.io/npm/v/github-spray.svg?style=flat-square)](https://www.npmjs.com/package/github-spray)

[![license](https://img.shields.io/github/license/annihil/github-spray.svg?style=flat-square)]()



	



A CLI to generate sprays for your GitHub contribution history graph

![](https://i.imgur.com/Of8MjPj.gif)

## 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

```

![](https://i.imgur.com/iF2xwwU.png)  

```sh

github-spray -t Mario? --font mario

```

![](https://i.imgur.com/0P8Dmrn.png)  

#### led7

![](https://i.imgur.com/O5EW9IV.png)  

![](https://i.imgur.com/yUaeoGL.png)  

![](https://i.imgur.com/mvtC6sE.png)  

![](https://i.imgur.com/A76n04M.gif)  

*Fonts available are in the fonts folder*

### Invert colors

![](https://i.imgur.com/rgSownU.png)

```sh

github-spray -t hello -i

```

### Flip vertical

![](https://i.imgur.com/xHNnAGb.png)

```sh

github-spray -t hello --flipvertical

```

### Flip horizontal

![](https://i.imgur.com/LMtZGAr.png)

```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  "

]

```

![](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](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/)