CLI to report on GitHub Actions
$ npx @stoe/action-reporting-cli [--options]-
--enterprise,-eGitHub Enterprise (Cloud|Server) account slug (e.g. enterprise). -
--owner,-oGitHub organization/user login (e.g. owner). If--owneris a user, results for the authenticated user (--token) will be returned. -
--repository,-rGitHub repository name with owner (e.g. owner/repo).
-
--token,-tGitHub Personal Access Token (PAT) (defaultGITHUB_TOKEN). -
--hostnameGitHub Enterprise Server hostname (defaultapi.github.com).
For example:github.example.com
-
--allReport all below. -
--listenersReportonlisteners used. -
--permissionsReportpermissionsvalues forGITHUB_TOKEN. -
--runs-onReportruns-onvalues. -
--secretsReportsecretsused. -
--usesReportusesvalues.-
--excludeExclude GitHub Actions created by GitHub.
From https://github.com/actions and https://github.com/github organizations.
Only applies to--uses. -
--uniqueList unique GitHub Actions.
Possible values aretrue,falseandboth.
Only applies to--uses. Will create an additional*-unique.{csv,json,md}report file.
-
-
--varsReportvarsused.
-
--csvPath to save CSV output (e.g. /path/to/reports/report.csv). -
--jsonPath to save JSON output (e.g. /path/to/reports/report.json). -
--mdPath to save markdown output (e.g. /path/to/reports/report.md).
-
--help,-hPrint action-reporting-cli help. -
--version,-vPrint action-reporting-cli version.
# Report on everything in the `my-enterprise` GitHub Enterprise Cloud account.
# Save CSV, JSON and markdown reports to `./reports/actions.{csv,json,md}`.
$ npx @stoe/action-reporting-cli \
--token ghp_000000000000000000000000000000000000 \
--enterprise my-enterprise \
--all \
--csv ./reports/actions.csv \
--json ./reports/actions.json \
--md ./reports/actions.md# Report on everything in the `my-org` GitHub organization.
# Save JSON report to `./reports/actions.json`.
$ npx @stoe/action-reporting-cli \
--token ghp_000000000000000000000000000000000000 \
--owner my-org \
--permissions \
--runs-on \
--secrets \
--uses \
--vars \
--json ./reports/actions.json# Report on unique GitHub Actions in the `my-org/myrepo` GitHub repository.
# Exclude GitHub Actions created by GitHub.
# Save CSV report to `./reports/actions.csv`.
$ npx @stoe/action-reporting-cli \
--token ghp_000000000000000000000000000000000000 \
--repository my-org/myrepo \
--uses \
--exclude \
--unique both \
--csv ./reports/actions.csv# Report on everything in the `my-org` GitHub organization on `github.example.com` GitHub Enterprise Server.
# Save JSON report to `./reports/actions.json`.
$ npx @stoe/action-reporting-cli \
--hostname github.example.com \
--token ghp_000000000000000000000000000000000000 \
--owner my-org \
--all \
--json ./reports/actions.json