Package Exports

github-spray

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-spray) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GitHub Spray

A CLI to generate sprays for your GitHub commit graph history

Installation

npm i -g github-spray

Requirement

Git
Recent NodeJS

Usage

Create a new GitHub repository and copy its url

github-spray -t <text> --push --origin <github_repository_url>

(example)

github-spray -t hello --push --origin https://github.com/John/hello.git

github-spray --help

Fonts

github-spray -t <text> --font <font_name>

(example)

github-spray -t Wald0 --font portable_vengeance

github-spray -t Mario? --font mario

Fonts available are in the fonts folder

Invert colors

github-spray -t hello -i

Custom pattern

To use a custom pattern, create a JSON file like follow.
The numbers (1 to 4) will determine the green's darkness.

[
    "  444  ",
    " 4   4 ",
    "4 3 3 4",
    "4     4",
    "4 333 4",
    " 4   4 ",
    "  444  "
]

github-spray -f <path/to/pattern.json> ...

You can use GitHub Spray Generator to graphically draw patterns

Custom start date

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.

Multiply every contributions

github-spray -t toto -m <factor>

Multiply each digits by the given factor

Known issues

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