https://github.com/mdb/gh-release-report

A gh CLI extension that reports and visualizes a GitHub release's downloads.
https://github.com/mdb/gh-release-report

gh-extension go golang

Last synced: about 2 months ago
JSON representation

A gh CLI extension that reports and visualizes a GitHub release's downloads.

• Host: GitHub
• URL: https://github.com/mdb/gh-release-report
• Owner: mdb
• Created: 2023-01-12T20:24:45.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T16:37:55.000Z (almost 2 years ago)
• Last Synced: 2024-11-13T13:54:42.563Z (about 2 months ago)
• Topics: gh-extension, go, golang
• Language: Go
• Homepage:
• Size: 343 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![CI/CD](https://github.com/mdb/gh-release-report/actions/workflows/cicd.yaml/badge.svg)](https://github.com/mdb/gh-release-report/actions/workflows/cicd.yaml)

# gh-release-report

A `gh` CLI extension that reports and visualizes a GitHub release's total

download count, as well as the individual download counts for each of its assets.

![demo](demo.gif)

## Usage

Inspect the download counts associated with a particular GitHub release:

```

gh release-report \

  --repo "cli/cli" \

  --tag "v1.0.0"

```

By default, the latest release associated with the current working directory's GitHub repository is targeted.

## Installation

Install the `gh` CLI [for your platform](https://github.com/cli/cli#installation). For example, on Mac OS:

```

brew install gh

```

Install the latest `release-report` extension from [its releases](https://github.com/mdb/gh-release-report/releases):

```

gh extension install mdb/gh-release-report

```

## Development

Build and test `gh-release-report` locally:

```

make

```

Install a locally built `gh-release-report` for use as `gh release-report`:

```

make install

```