https://github.com/koki-develop/gh-grass

🍀 Grow github grass to console.
https://github.com/koki-develop/gh-grass

Last synced: 10 months ago
JSON representation

🍀 Grow github grass to console.

• Host: GitHub
• URL: https://github.com/koki-develop/gh-grass
• Owner: koki-develop
• License: mit
• Created: 2023-04-15T11:16:01.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-29T04:37:49.000Z (about 2 years ago)
• Last Synced: 2025-03-23T03:51:09.329Z (11 months ago)
• Language: Go
• Homepage:
• Size: 825 KB
• Stars: 45
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
























Grow github grass to console.



# gh-grass

- [Installation](#installation)

- [Usage](#usage)

- [LICENSE](#license)

## Installation

```sh

$ gh extension install koki-develop/gh-grass

```

## Usage

```console

$ gh grass --help

Grow github grass to console.

Usage:

  gh grass [flags]

Flags:

  -u, --user string    github username

      --from string    only contributions made at this time or later will be counted

      --to string      only contributions made before and up to (including) this time will be counted

  -t, --theme string   grass theme (dark|light) (default "dark")

  -g, --grass string   grass string (default "■")

  -a, --animate        animate grass

      --total          print total contributions

  -h, --help           help for gh

```

### Basic

```sh

$ gh grass

```

![demo](./assets/demo.gif)

### Specify a User

```sh

$ gh grass --user 

# e.g.

$ gh grass --user koki-develop

```

![](./assets/user.gif)

### Specify Time Period

```sh

$ gh grass --from ""

$ gh grass --to ""

$ gh grass --from "" --to ""

```

![](./assets/period.gif)

### Change Theme

```sh

$ gh grass --theme 

# e.g.

$ gh grass --theme light

```

![](./assets/theme.gif)

### Custom Grass

```sh

$ gh grass --grass ""

# e.g.

$ gh grass --grass "●"

```

![](./assets/grass.gif)

### Animation

```sh

$ gh grass --animate

```

![](./assets/animate.gif)

### Print Total Contributions

```sh

$ gh grass --total

```

![](./assets/total.gif)

## LICENSE

[MIT](./LICENSE)