action-permissions-cli
CLI to grab GitHub action
permissions
for actions usingGITHUB_TOKEN
.Useful if you want to get started with Control permissions for
GITHUB_TOKEN
but 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
,-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
-
--csv
Path to CSV file for the output (e.g./path/to/action-permissions.csv
) -
--md
Path to markdown file for the output (e.g./path/to/action-permissions.md
) -
--token
,-t
GitHub Personal Access Token (PAT) (defaultGITHUB_TOKEN
) -
--help
,-h
Print action-permissions-cli help -
--version
,-v
Print 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