$ pinact --help
NAME:
pinact - Pin GitHub Actions versions. https://github.com/suzuki-shunsuke/pinact
USAGE:
pinact [global options] [command [command options]]
VERSION:
4.1.0
COMMANDS:
init Create a pinact configuration file if it doesn't exist
run Pin GitHub Actions versions
migrate Migrate .pinact.yaml
token Manage GitHub Access token
version Show version
help, h Shows a list of commands or help for one command
completion Output shell completion script for bash, zsh, fish, or Powershell
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
--help, -h show help
--version, -v print the version
$ pinact init --help
NAME:
pinact init - Create a pinact configuration file if it doesn't exist
USAGE:
pinact init [options]
DESCRIPTION:
Create a pinact configuration file if it doesn't exist. The resolved path is printed to stdout.
$ pinact init # creates .pinact.yaml in the current directory
$ pinact init .github/pinact.yaml # explicit path
$ pinact init -g # creates the user-wide global config
OPTIONS:
--global, -g Create the user-wide global config file (~/.config/pinact/pinact.yaml on Unix, %APPDATA%\pinact\pinact.yaml on Windows). The parent directory is created if it does not exist.
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ pinact run --help
NAME:
pinact run - Pin GitHub Actions versions
USAGE:
pinact run [options] [files ...]
DESCRIPTION:
If no argument is passed, pinact searches GitHub Actions workflow files from .github/workflows.
$ pinact run
You can also pass workflow file paths as arguments.
e.g.
$ pinact run .github/actions/foo/action.yaml .github/actions/bar/action.yaml
OPTIONS:
--verify-comment, --verify, -v Verify that the version comment matches the pinned SHA
--verify-min-age Audit every pinned action against the min-age threshold (calls the GitHub API). Auto-enabled when -min-age is set on the CLI
--no-api Skip GitHub API calls. Only the syntactic pin check (40-character SHA) is performed
--check Alias for -fix=false. For offline check use -fix=false -no-api
--update, -u Update actions to latest versions
--fix Fix code. By default, this is true. If -check or -diff is true, this is false by default
--diff Alias for -fix=false. Note: -diff=false is ignored because detail output is always printed in v4
--format string Output format. Currently only 'sarif' is supported. If sarif is specified, results are output in SARIF format to stdout
--include string, -i string [ --include string, -i string ] A regular expression to fix actions
--exclude string, -e string [ --exclude string, -e string ] A regular expression to exclude actions
--branch-to-tag string [ --branch-to-tag string ] A regular expression to convert non-semver versions (e.g. branch names) to the latest stable tag. Anchor with ^$ for exact match
--min-age int, -m int Minimum release age threshold in days. Setting this (either via CLI or PINACT_MIN_AGE) implicitly enables -verify-min-age (default: 0) [$PINACT_MIN_AGE]
--separator string, --sep string Separator between version and tag comment
--diff-file + Path to a unified diff. Only the + lines of the diff are processed (use `-` to read the diff from stdin). Useful in PR CI to limit pinact to lines changed by the PR
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ pinact migrate --help
NAME:
pinact migrate - Migrate .pinact.yaml
USAGE:
pinact migrate [options]
DESCRIPTION:
Migrate the version of .pinact.yaml
$ pinact migrate
OPTIONS:
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ pinact token --help
NAME:
pinact token - Manage GitHub Access token
USAGE:
pinact token [command [command options]]
DESCRIPTION:
Manage GitHub Access token by keyring.
COMMANDS:
set Set GitHub Access token
remove, rm Remove GitHub Access token
OPTIONS:
--help, -h show help
$ token set --help
NAME:
pinact token set - Set GitHub Access token
USAGE:
pinact token set [options]
DESCRIPTION:
Set GitHub Access token to keyring.
OPTIONS:
--stdin Read GitHub Access token from stdin
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ token remove --help
NAME:
pinact token remove - Remove GitHub Access token
USAGE:
pinact token remove [options]
DESCRIPTION:
Remove GitHub Access token from keyring.
OPTIONS:
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ pinact version --help
NAME:
pinact version - Show version
USAGE:
pinact version [options]
OPTIONS:
--json, -j Output version in JSON format
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]
$ pinact completion --help
NAME:
pinact completion - Output shell completion script for bash, zsh, fish, or Powershell
USAGE:
pinact completion [options]
DESCRIPTION:
Output shell completion script for bash, zsh, fish, or Powershell.
Source the output to enable completion.
# .bashrc
source <(pinact completion bash)
# .zshrc
source <(pinact completion zsh)
# fish
pinact completion fish > ~/.config/fish/completions/pinact.fish
# Powershell
Output the script to path/to/autocomplete/pinact.ps1 an run it.
OPTIONS:
--help, -h show help
GLOBAL OPTIONS:
--log-level string log level [$PINACT_LOG_LEVEL]
--config string, -c string configuration file path [$PINACT_CONFIG]