github-nippou

Print today's your GitHub activity for issues and pull requests.

This is a helpful CLI when you write a daily report in reference to GitHub. Nippou is a japanese word which means a daily report.

A web version of this CLI is also available at https://github.com/MH4GF/github-nippou-web .

Installation

Grab the latest binary from the releases page.

On macOS you can install or upgrade to the latest released version with Homebrew:

$ brew install masutaka/tap/github-nippou
$ brew upgrade github-nippou

If you're interested in hacking on github-nippou, you can install via go install:

$ go install github.com/masutaka/github-nippou/v4@latest

Also you can use make command, it's easy to build github-nippou:

$ make deps
$ make
$ ./github-nippou

Setup

$ github-nippou init

The initialization will be update your Git global configuration file.

Add github-nippou.user
Add github-nippou.token
Create Gist, and add github-nippou.settings-gist-id for customizing output format (optional)

Usage

$ github-nippou help
Print today's your GitHub activity for issues and pull requests

Usage:
  github-nippou [flags]
  github-nippou [command]

Available Commands:
  completion    Generate the autocompletion script for the specified shell
  help          Help about any command
  init          Initialize github-nippou settings
  list          Print today's your GitHub activity for issues and pull requests
  open-settings Open settings url with web browser
  version       Print version

Flags:
  -d, --debug               Debug mode
  -h, --help                help for github-nippou
  -s, --since-date string   Retrieves GitHub user_events since the date (default "20231028")
  -u, --until-date string   Retrieves GitHub user_events until the date (default "20231028")

Use "github-nippou [command] --help" for more information about a command.

You can get your GitHub Nippou on today.

$ github-nippou

### masutaka/github-nippou

* [v3.0.0](https://github.com/masutaka/github-nippou/issues/59) by @[masutaka](https://github.com/masutaka)
* [Enable to inject settings_gist_id instead of the settings](https://github.com/masutaka/github-nippou/pull/63) by @[masutaka](https://github.com/masutaka) **merged!**
* [Add y/n prompt to sub command \`init\`](https://github.com/masutaka/github-nippou/pull/64) by @[masutaka](https://github.com/masutaka) **merged!**
* [Add sub command \`open-settings\`](https://github.com/masutaka/github-nippou/pull/65) by @[masutaka](https://github.com/masutaka) **merged!**
* [Dockerize](https://github.com/masutaka/github-nippou/pull/66) by @[masutaka](https://github.com/masutaka) **merged!**

Optional: Customize Output Format

Customize the list output format as needed. Configurations are stored in a Gist.
Running github-nippou init creates your Gist and adds its ID to github-nippou.settings-gist-id.

View the default configuration here.

Available Properties

`format.subject`

Property	Type	Description
`subject`	`string`	Represents the repository name.

`format.line`

Property	Type	Description
`user`	`string`	Displays the username of author of the issue or pull request.
`title`	`string`	Displays the title of the issue or pull request.
`url`	`string`	Displays the URL of the issue or pull request.
`status`	`string \| nil`	Displays the status, utilizing the format in `dictionary.status`.

`format.dictionary.status`

Property	Type	Description
`closed`	`string`	Displays when the issue or pull request is closed.
`merged`	`string`	Displays when the pull request is merged. Applicable to pull requests only.

Limitations and Latency

github-nippou uses the GitHub List events for the authenticated user API.

🔗 REST API endpoints for events - GitHub Docs

Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).

github-nippou can create past daily reports, but the above limitations apply.

This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

As of July 29, 2024, the above is a note regarding the List repository events API, but I confirmed with GitHub support that it applies to all Event APIs.

Contributing

Fork it ( https://github.com/masutaka/github-nippou/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Contributors

Made with contrib.rocks.

License

External articles

In Japanese

github-nippou

Development

Runtime

github-nippou

Installation

Setup

Usage

Optional: Customize Output Format

Available Properties

`format.subject`

`format.line`

`format.dictionary.status`

Limitations and Latency

Contributing

Contributors

License

External articles