https://github.com/trustin/gh-cmp

Lists the open and unread issues and pull requests from the GitHub and GitHub Enterprise repositories you're interested in.
https://github.com/trustin/gh-cmp

cli code-review github github-issues pull-requests

Last synced: 6 months ago
JSON representation

Lists the open and unread issues and pull requests from the GitHub and GitHub Enterprise repositories you're interested in.

• Host: GitHub
• URL: https://github.com/trustin/gh-cmp
• Owner: trustin
• Created: 2023-03-15T12:08:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-15T12:49:57.000Z (over 2 years ago)
• Last Synced: 2025-03-29T22:11:46.666Z (6 months ago)
• Topics: cli, code-review, github, github-issues, pull-requests
• Homepage:
• Size: 1 MB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## gh-cmp

`gh-cmp` (GitHub, Check My Projects) lists the open and unread issues and pull requests from the GitHub and GitHub Enterprise repositories you're interested in.

Without this script, you'd have to check very noisy [GitHub notifications](https://github.com/notifications) or open a browser tab for each repository.

![Screenshot](screenshot.png)

### Requirements

- [google/zx](https://github.com/google/zx)

  - MacOS: `brew install zx`

- [GitHub CLI](https://cli.github.com)

  - MacOS: `brew install gh`

  - `gh-cmp` is a frontend of GitHub CLI. Therefore, you need to make sure GitHub CLI is configured properly to send API requests. Acquire the access token beforehand by running `gh auth login`.

### Configuration

Put the list of the repositories you're interested in to `~/.config/gh-cmp/repositories.json5`, e.g.

```json5

[

  {

    // github.com/trustin/gh-cmp

    owner: 'trustin',

    name: 'gh-cmp',

  },

  // {

  //   // github-enterprise.acme.com/acme-engineering/acme-server

  //   host: 'github-enterprise.acme.com',

  //   owner: 'acme-engineering',

  //   repo: 'acme-server',

  // },

]

```

### Future works

- Use [Github notifications API](https://docs.github.com/en/rest/activity/notifications).

  - Get the complete list of unread items and remove uninteresting ones.

  - Get the unread discussions.

  - Summarize the failed actions.

- More customizability

- Single binary distribution