Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blaise-io/contribution
CLI tool to draw an image on your GitHub contribution graph.
https://github.com/blaise-io/contribution
cli-app contribution github golang
Last synced: 7 days ago
JSON representation
CLI tool to draw an image on your GitHub contribution graph.
- Host: GitHub
- URL: https://github.com/blaise-io/contribution
- Owner: blaise-io
- License: mit
- Created: 2020-07-07T05:59:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T19:16:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-25T05:53:14.815Z (14 days ago)
- Topics: cli-app, contribution, github, golang
- Language: Go
- Homepage:
- Size: 47.9 KB
- Stars: 202
- Watchers: 6
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Contribution
Draw an image on your GitHub contribution graph.
#### Examples
|  |  |
| ------------------------------------------- | ------------------------------------------- |
|  |  |
## How does it work?
GitHub displays commits in the contribution history graph. Contribution pushes
a bunch of commits with a custom date using `git commit --date `. It
bundles multiple commits on a single day to achieve a darker pixel in the graph.
The GitHub contribution graph is 52 × 7 pixels and shows up to five shades for
activity. This app automatically limits the colors and dimensions of your input
image to match these restrictions. Use the [preview](#contribution-preview--help)
subcommand if you're not feeling lucky.
Warning: you cannot remove contribution activity on GitHub unless you delete a
project, so you probably want to push to a project specifically created for
this purpose. Contributions to secret projects may also be shown, depending on
your GitHub settings.
Contribution uses your default SSH identity. If you want to use another identity,
you can do so by setting the [`GIT_SSH_COMMAND` and `GIT_AUTHOR_EMAIL` env variables.](https://gist.github.com/blaise-io/7a90dafb9ecee3022c8cf89e92b4dcc4)
## Download
You can find prebuilt binaries voor Windows, macOS and Linux in
[releases](https://github.com/blaise-io/contribution/releases/latest).
Or clone the project and build yourself.
- [Use the source image of these examples](image/source)
- [Create your own using this palette image](image/source/palette.png)
If you don't have Paint installed you can use a free online tool like
[pixilart.com](https://www.pixilart.com/draw).
## How to use
Contribution is provided as a binary with a command line interface.
### `contribution -help`
```
Draw an image on your GitHub contribution history.
By Blaise Kal, 2021
Preview contribution history graph without pushing
contribution preview -img /path/to/image.png
Preview usage and options
contribution preview -help
Push contribution history graph to GitHub
contribution push -img /path/to/image.png -project username/project
Push usage and options
contribution push -help
```
### `contribution preview -help`
```
Preview contribution history graph without pushing.
Example usage:
contribution preview -img image.png
-img string
Path to a valid PNG image. (required)
```
### `contribution push -help`
```
Push contribution history graph to GitHub
Example usage:
contribution push -project username/project
-branch string
Git branch to push to. (default "contribution")
-img string
Path to a valid PNG image. (required)
-project string
GitHub username/project to push to. (required)
-w int
Weeks ago of all activity. A value of 2 will move activity two pixels to the left.
```