github-nippou

Project Overview

github-nippou is a Command Line Interface (CLI) tool designed to streamline daily reporting of GitHub activities, specifically focusing on issues and pull requests. The term "Nippou" originates from Japanese, meaning a daily report, reflecting the purpose of the tool in simplifying how developers document their contributions on GitHub.

Key Features

• Activity Tracking: Effortlessly print GitHub activity for the day related to issues and pull requests.
• Customization: Configure the output format to meet specific reporting needs by utilizing Gists for storing settings.
• Integration Support: Use as a library to power various applications, enhancing functionality and usability across projects.

Installation and Setup

Obtaining the latest binary is recommended via the releases page. For macOS users, installation via Homebrew is straightforward:

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

The tool can also be installed by using the Go package manager or through the Make command, ensuring easy accessibility for developers who wish to modify or extend its capabilities.

Getting Started

To initiate the setup:

$ github-nippou init

This command configures your Git global settings and prepares the tool for usage. It prompts users to input their GitHub username and personal access token, as well as the option to customize the output format via Gist ID.

Example Usage

Run the following command to retrieve today's GitHub activity:

$ github-nippou

This command outputs a summary of activities, showcasing merge requests, issues, and other relevant interactions:

### 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!**

Custom Output Format

The output format can be customized based on the users' preferences, allowing flexibility in how activity reports are structured. Properties such as format.subject and format.line define how information related to repository names and issue/pr details is displayed.

Limitations

As github-nippou depends on the GitHub API, it is subject to certain limitations, including an event timeline viewable up to 90 days and potential latency in event processing.

Contribution Guidelines

To contribute to the development of github-nippou, one can fork the repository, create a feature branch, and submit a pull request to propose changes or additions.

Community and External Resources

For additional context and insights, external articles and documentation are available in multiple languages, further enriching the understanding and use of github-nippou.

By offering a clear, concise method for tracking daily GitHub activities, github-nippou enhances productivity and ensures developers maintain accurate records of their contributions.