contributors

A CLI tool that fetches and displays contributors for a GitHub repository, sorted by number of contributions.

Building

Install to build/install/contributors-shadow/ (bin + lib layout):

./gradlew installShadowDist

Or build a distributable archive:

./gradlew shadowDistZip   # build/distributions/contributors-shadow-0.1.zip
./gradlew shadowDistTar   # build/distributions/contributors-shadow-0.1.tar

Usage

build/install/contributors-shadow/bin/contributors -o <owner> -r <repo> [options]

During development you can also run directly via Gradle:

./gradlew run --args="-o <owner> -r <repo> [options]"

Options

Option	Description
-o, --owner	Repository owner (required)
-r, --repo	Repository name (required)
-t, --token	GitHub personal access token (overrides GITHUB_TOKEN env var)
-m, --min-contributions	Exclude contributors below this threshold (default: 1)
--include-bots	Include bot accounts such as dependabot[bot] or renovate-bot (excluded by default)
-j, --json	Output as JSON instead of the default format
-h, --help	Show help

Authentication

To avoid GitHub API rate limits, provide a personal access token either via the environment or the CLI flag:

export GITHUB_TOKEN=ghp_yourtoken
build/install/contributors-shadow/bin/contributors -o grails -r grails-core

# or inline
build/install/contributors-shadow/bin/contributors -o grails -r grails-core --token ghp_yourtoken

Examples

Default output (Groovy-style map, sorted by contributions):

build/install/contributors-shadow/bin/contributors -o grails -r grails-core

   developers = [
           graemerocher : "Graeme Rocher",
           sbglasius    : "Søren Berg Glasius",
   ]

Only contributors with at least 10 contributions:

build/install/contributors-shadow/bin/contributors -o grails -r grails-core -m 10

JSON output:

build/install/contributors-shadow/bin/contributors -o grails -r grails-core --json

Running Tests

./gradlew test