jborkowski / crime-report

Introduction

The crime-report is simple tool to automate paperwork related to copyright transfers to clients. The tool produces a list of contributions to organization repositories for a specific GitHub user within a specified period.

Usage

Download prebuilt binary (or build on your machine) and then copy it to ~/.local/bin/ (Make sure you have this in your PATH).

NOTE Accessing private repositories requires passing your GH_TOKEN. The tool can get it from an environment variable or param --gh-token

Then you can execute tool by passing necessary params:

λ crime-report --since 2020-12-01 --until 2020-12-31 -U jborkowski --gh-token your-gh-token

More information about available options you can get by running program with --help flag

λ crime-report --help

Usage: crime-report [OPTIONS] --user <USER>

Options:
  -s, --since <SINCE>
          [default: 2023-01-01]
  -u, --until <UNTIL>
          [default: 2023-01-02]
      --owner <OWNER>
          [default: restaumatic]
  -U, --user <USER>

      --gh-token <GH_TOKEN>
          [default: env GH_TOKEN]
  -h, --help
          Print help information
  -V, --version
        Print version information