{"id":18986738,"url":"https://github.com/stoe/action-reporting-cli","last_synced_at":"2025-04-16T14:27:34.708Z","repository":{"id":42986002,"uuid":"462351925","full_name":"stoe/action-reporting-cli","owner":"stoe","description":"CLI to report on GitHub Actions","archived":false,"fork":false,"pushed_at":"2025-04-01T06:47:22.000Z","size":568,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T16:51:20.566Z","etag":null,"topics":["cli","github","reporting"],"latest_commit_sha":null,"homepage":"https://npm.im/@stoe/action-reporting-cli","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stoe.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/codeowners","security":".github/security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stoe"]}},"created_at":"2022-02-22T15:11:49.000Z","updated_at":"2025-04-01T06:47:25.000Z","dependencies_parsed_at":"2023-02-18T12:55:21.896Z","dependency_job_id":"2e1a6c51-ca10-4ff5-b3ea-d45c25a5d75b","html_url":"https://github.com/stoe/action-reporting-cli","commit_stats":{"total_commits":54,"total_committers":5,"mean_commits":10.8,"dds":0.4629629629629629,"last_synced_commit":"18e17bed5df41818e0bd199e30c61adc135c4cd3"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoe%2Faction-reporting-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoe%2Faction-reporting-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoe%2Faction-reporting-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stoe%2Faction-reporting-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stoe","download_url":"https://codeload.github.com/stoe/action-reporting-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249250428,"owners_count":21237896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","github","reporting"],"created_at":"2024-11-08T16:35:09.467Z","updated_at":"2025-04-16T14:27:34.681Z","avatar_url":"https://github.com/stoe.png","language":"JavaScript","readme":"# action-reporting-cli\n\n[![test](https://github.com/stoe/action-reporting-cli/actions/workflows/test.yml/badge.svg)](https://github.com/stoe/action-reporting-cli/actions/workflows/test.yml) [![CodeQL](https://github.com/stoe/action-reporting-cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/stoe/action-reporting-cli/actions/workflows/github-code-scanning/codeql) [![publish](https://github.com/stoe/action-reporting-cli/actions/workflows/publish.yml/badge.svg)](https://github.com/stoe/action-reporting-cli/actions/workflows/publish.yml) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\n\u003e CLI to report on GitHub Actions\n\n## Usage example\n\n```sh\n$ npx @stoe/action-reporting-cli [--options]\n```\n\n## Required options [one of]\n\n- `--enterprise`, `-e` GitHub Enterprise (Cloud|Server) account slug (e.g. _enterprise_).\n- `--owner`, `-o` GitHub organization/user login (e.g. _owner_).\n  If `--owner` is a user, results for the authenticated user (`--token`) will be returned.\n- `--repository`, `-r` GitHub repository name with owner (e.g. _owner/repo_).\n\n## Additional options\n\n- `--token`, `-t` GitHub Personal Access Token (PAT) (default `GITHUB_TOKEN`).\n- `--hostname` GitHub Enterprise Server hostname (default `api.github.com`).\u003cbr/\u003e\n  For example: `github.example.com`\n\n## Report options\n\n- `--all` Report all below.\n- `--listeners` Report `on` listeners used.\n- `--permissions` Report `permissions` values for `GITHUB_TOKEN`.\n- `--runs-on` Report `runs-on` values.\n- `--secrets` Report `secrets` used.\n- `--uses` Report `uses` values.\n  - `--exclude` Exclude GitHub Actions created by GitHub.\u003cbr/\u003e\n    From https://github.com/actions and https://github.com/github organizations.\u003cbr/\u003e\n    Only applies to `--uses`.\n  - `--unique` List unique GitHub Actions.\u003cbr/\u003e\n    Possible values are `true`, `false` and `both`.\u003cbr/\u003e\n    Only applies to `--uses`. Will create an additional `*-unique.{csv,json,md}` report file.\n- `--vars` Report `vars` used.\n\n## Report output options\n\n- `--csv` Path to save CSV output (e.g. /path/to/reports/report.csv).\n- `--json` Path to save JSON output (e.g. /path/to/reports/report.json).\n- `--md` Path to save markdown output (e.g. /path/to/reports/report.md).\n\n## Helper options\n\n- `--help`, `-h` Print action-reporting-cli help.\n- `--version`, `-v` Print action-reporting-cli version.\n\n## Examples\n\n```sh\n# Report on everything in the `my-enterprise` GitHub Enterprise Cloud account.\n# Save CSV, JSON and markdown reports to `./reports/actions.{csv,json,md}`.\n$ npx @stoe/action-reporting-cli \\\n  --token ghp_000000000000000000000000000000000000 \\\n  --enterprise my-enterprise \\\n  --all \\\n  --csv ./reports/actions.csv \\\n  --json ./reports/actions.json \\\n  --md ./reports/actions.md\n```\n\n```sh\n# Report on everything in the `my-org` GitHub organization.\n# Save JSON report to `./reports/actions.json`.\n$ npx @stoe/action-reporting-cli \\\n  --token ghp_000000000000000000000000000000000000 \\\n  --owner my-org \\\n  --permissions \\\n  --runs-on \\\n  --secrets \\\n  --uses \\\n  --vars \\\n  --json ./reports/actions.json\n```\n\n```sh\n# Report on unique GitHub Actions in the `my-org/myrepo` GitHub repository.\n# Exclude GitHub Actions created by GitHub.\n# Save CSV report to `./reports/actions.csv`.\n$ npx @stoe/action-reporting-cli \\\n  --token ghp_000000000000000000000000000000000000 \\\n  --repository my-org/myrepo \\\n  --uses \\\n  --exclude \\\n  --unique both \\\n  --csv ./reports/actions.csv\n```\n\n```sh\n# Report on everything in the `my-org` GitHub organization on `github.example.com` GitHub Enterprise Server.\n# Save JSON report to `./reports/actions.json`.\n$ npx @stoe/action-reporting-cli \\\n  --hostname github.example.com \\\n  --token ghp_000000000000000000000000000000000000 \\\n  --owner my-org \\\n  --all \\\n  --json ./reports/actions.json\n```\n\n## License\n\n[MIT](./license) © [Stefan Stölzle](https://github.com/stoe)\n","funding_links":["https://github.com/sponsors/stoe"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstoe%2Faction-reporting-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstoe%2Faction-reporting-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstoe%2Faction-reporting-cli/lists"}