GitHub Report tool.
- Free software: BSD 3 Clause
- Documentation: https://opensciencelabs.github.io/ghreports
In order to create a configuration file, add to your project, at the root level, a file called .ghreports.yaml, with the following structure:
name: myproject-name-slug
title: "My Report Title"
env-file: .env
repos:
- myorg-1/myproject1
authors:
- gh-username-1: GitHub Username 1
output-dir: "/tmp/ghreports"ghreports --start-date 2025-07-01 --end-date 2025-07-31 --config-file tests/.ghreports.yaml
You can also specify the token in the command line as an argument:
ghreports --start-date 2025-07-01 --end-date 2025-07-31 --gh-token blabla --config-file tests/.ghreports.yaml