Skip to content

action-reporting-cli 1.0.0

Install from the command line:
Learn more about npm packages
$ npm install @stoe/action-reporting-cli@1.0.0
Install via package.json:
"@stoe/action-reporting-cli": "1.0.0"

About this version

action-reporting-cli

test codeql publish styled with prettier

CLI to report on GitHub Actions

Usage

$ npx @stoe/action-reporting-cli [--options]

Required options [one of]

  • --enterprise, -e GitHub Enterprise Cloud account slug (e.g. enterprise).
  • --owner, -o GitHub organization/user login (e.g. owner). If --owner is a user, results for the authenticated user (--token) will be returned.
  • --repository, -r GitHub repository name with owner (e.g. owner/repo).

Additional options

  • --token, -t GitHub Personal Access Token (PAT) (default GITHUB_TOKEN).
  • --permissions Report permissions values for GITHUB_TOKEN.
  • --uses Report uses values.
  • --exclude Exclude GitHub Actions created by GitHub. From https://github.com/actions and https://github.com/github organizations. Only applies to --uses.
  • --unique List unique GitHub Actions. Possible values are true, false and both. Only applies to --uses. Will create an additional *-unique.{csv,json,md} report file.

Report output options

  • --csv Path to save CSV output (e.g. /path/to/reports/report.csv).
  • --json Path to save JSON output (e.g. /path/to/reports/report.json).
  • --md Path to save markdown output (e.g. /path/to/reports/report.md).

Helper options

  • --help, -h Print action-reporting-cli help.
  • --version, -v Print action-reporting-cli version.

Examples

# TODO

License

MIT © Stefan Stölzle

Details


Assets

  • action-reporting-cli-1.0.0-npm.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0