action-permissions-cli
CLI to grab GitHub action
permissionsfor actions usingGITHUB_TOKEN.Useful if you want to get started with Control permissions for
GITHUB_TOKENbut don't know where that token is used across your enterprise/organisation/user repositories.
Usage
$ npx @stoe/action-permissions-cli [--options]Required options (one of)
-
--enterprise,-eGitHub Enterprise Cloud account slug (e.g.enterprise) -
--owner,-oGitHub organization/user login (e.g.owner) If --owner is a user, results for the authenticated user (--token) will be returned -
--repository,-rGitHub repository name with owner (e.g.owner/repo)
Additional options
-
--csvPath to CSV file for the output (e.g./path/to/action-permissions.csv) -
--mdPath to markdown file for the output (e.g./path/to/action-permissions.md) -
--token,-tGitHub Personal Access Token (PAT) (defaultGITHUB_TOKEN) -
--help,-hPrint action-permissions-cli help -
--version,-vPrint action-permissions-cli version
Examples
# Output GitHub Actions `permissions` for all repositories under a GitHub Enterprise Cloud account to stdout
$ npx @stoe/action-permissions-cli -e my-enterprise
# Output GitHub Actions `permissions` for all organization repositories to stdout
$ npx @stoe/action-permissions-cli -o my-org
# Output GitHub Actions `permissions` for all user repositories to stdout
$ npx @stoe/action-permissions-cli -o stoe
# Output GitHub Actions `permissions` for the stoe/action-permissions-cli repository to stdout
$ npx @stoe/action-permissions-cli -r stoe/action-permissions-cli
# Output GitHub Actions `permissions` for all organization repositories to /path/to/action-permissions.csv
$ npx @stoe/action-permissions-cli -o my-org --csv /path/to/action-permissions.csv
# Output GitHub Actions `permissions` for all organization repositories to /path/to/action-permissions.md
$ npx @stoe/action-permissions-cli -o my-org --md /path/to/action-permissions.md