Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/annurdien/git-cheater
Github fake commit generator, for fun only
https://github.com/annurdien/git-cheater
fake-commit github
Last synced: about 1 month ago
JSON representation
Github fake commit generator, for fun only
- Host: GitHub
- URL: https://github.com/annurdien/git-cheater
- Owner: annurdien
- License: mit
- Created: 2022-01-31T19:00:01.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-31T20:28:04.000Z (almost 3 years ago)
- Last Synced: 2024-03-25T16:20:52.888Z (9 months ago)
- Topics: fake-commit, github
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Cheat - Commits Generator
A command-line tool to generate your GitHub activity graph.
Are you lazy? but you wanna show off your coding skill's to your friends and family? This tool will help you.
## How To Use
1. Make sure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and
[Node.js](https://nodejs.org/en/download/) installed on your machine.
3. Generate your commits:
```shell script
npx git-cheater
```
It will create `cheat-folder` folder, initialize git and generate commits for every day within the last year (0-3 commits per day).
4. Create [a private repository](https://github.com/new) in your GitHub called `cheat-folder`
and push the changes:
```shell script
cd cheat-folder
git remote add origin [email protected]:/cheat-folder.git
git push -u origin master
```
Done! Go take a look at your GitHub profile 😉
## Customizations
### `--commitsPerDay`
Specify how many commits should be created for every single day.
Default is `0,3` which means it will randomly make from 0 to 3 commits a day. Example:
```shell script
npx git-cheater --commitsPerDay "0,5"
```
### `--weekdaysOnly`
Use it if you don't want to commit on weekends. Example:
```shell script
npx git-cheater --weekdaysOnly
```
### `--startDate` and `--endDate`
By default, the script generates GitHub commits for every day within the last year.
If you want to generate activity for a specific dates, then use these options:
```shell script
npx git-cheater --startDate "2020/09/01" --endDate "2020/09/30"
```
### `--resume`
By default, the script will create new local Git directory and delete any previous folder.
If you don't want to delete previous and just want to add new commit, then use these options:
```shell script
npx git-cheater --startDate "2020/10/01" --endDate "2020/12/30" --resume
```
# More
### `--help`
See full documentation
```shell script
npx git-cheater --help
```
## PS
It is something I wrote as a joke, so don't take it seriousely. I'm not encourage you to cheat, but I think green graph is so satisfying to watch 🤓