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
CLI to report on GitHub Actions
$ npx @stoe/action-reporting-cli [--options]
-
--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).
-
--token
,-t
GitHub Personal Access Token (PAT) (defaultGITHUB_TOKEN
). -
--permissions
Reportpermissions
values forGITHUB_TOKEN
. -
--uses
Reportuses
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 aretrue
,false
andboth
. Only applies to--uses
. Will create an additional*-unique.{csv,json,md}
report file.
-
--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).
-
--help
,-h
Print action-reporting-cli help. -
--version
,-v
Print action-reporting-cli version.
# TODO