# gitart

> fun art with git contributions

Latest version **1.0.4** (published 2021-06-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitart
pnpm add gitart
yarn add gitart
bun add gitart
```

Provides the command `gitart`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-06-19 |
| First published | 2021-06-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 74.9 KB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | AmirRezaDalir |
| Maintainers | dalirnet |
| Keywords | git, commit, contributions, contribute, fun, github, gitlab, iran |

## Links

- npm: https://www.npmjs.com/package/gitart
- Repository: https://github.com/dalirnet/gitart
- Homepage: https://github.com/dalirnet/gitart#readme
- Issues: https://github.com/dalirnet/gitart/issues
- npm.io page: https://npm.io/package/gitart

## Dependencies (6)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [dayjs](https://npm.io/package/dayjs.md) ^1.10.5
- [yargs](https://npm.io/package/yargs.md) ^17.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [simple-git](https://npm.io/package/simple-git.md) ^2.40.0

## Recent versions

- 1.0.4 (latest) — 2021-06-19
- 1.0.2 — 2021-06-19
- 1.0.1 — 2021-06-19
- 1.0.0 — 2021-06-19

## README

# GitArt

## Fun art with git contributions

### Sample [live](https://github.com/dalirnet?tab=overview&from=2011-12-01&to=2011-12-31)

![light](sample/light.png)

![dark](sample/dark.png)

### Command

-   `--text` `-t`

    -   Text for drawing
    -   Default 'GitArt'

-   `--year` `-y`

    -   Year of commits
    -   Default 2000
    -   Min 2000
    -   Max 2020

-   `--gap` `-g`

    -   Gap from start of year
    -   Default 1
    -   Min 1
    -   Max 45

-   `--cpd` `-c`
    -   Commits per day
    -   Default 1
    -   Min 1
    -   Max 9

### Generate

```bash
# With npm

npx gitart --text 'dalirnet !!??' --year 2011 --gap 1 --cpd 1
```

```bash
# With github

npx github:dalirnet/gitart -t 'dalirnet !!??' -y 2011 -g 1 -c 1
```

```bash
# Output

✔ Generated "DALIRNET !!?  ." at /path/to/GitArts/GitArt2011
```

### Publish

```bash
# Change directory

cd /path/to/GitArts/GitArt2011
```

```bash
# Add remote

git remote add origin https://github.com/user/GitArt2011.git
```

```bash
# Push to remote

git push -u origin main
```

---
_Source: https://npm.io/package/gitart · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
