Command referencegh pr checks
gh pr checks command (Linux & Windows / GitHub CLI)
What it does
Show GitHub Actions and status-check results for a pull request. When people search for gh pr checks, they usually want practical GitHub CLI flags, safe examples, and how this subcommand fits everyday PR and repo workflows on Linux, Windows, and macOS. Syntax, options, and copyable examples are below.
Show GitHub Actions and status-check results for a pull request.
Syntax
gh pr checks [<number> | <url> | <branch>] [flags]
Common options
| Flag / option | Meaning |
|---|---|
| --watch | Watch checks until they finish. |
| --fail-fast | Stop watching when a required check fails. |
| --required | Show only required checks when supported. |
Practical examples
Checks for current PR
gh pr checks
Lists check names and pass/fail state.
Watch CI
gh pr checks --watch
Refreshes until checks complete.
Specific PR
gh pr checks 123
Shows checks for pull request 123.
Common mistakes
- Merging while checks are still pending.
- Confusing job names from `gh run list` with the aggregated PR checks view.
Related commands
- gh pr statusShow pull request status relevant to your work: current branch, created PRs, and review requests.
- gh run listList recent GitHub Actions workflow runs for the repository.
- gh run watchWatch a GitHub Actions run until it completes, printing progress updates.
- gh pr mergeMerge a pull request using merge commit, squash, or rebase strategies.
- gh auth loginAuthenticate the GitHub CLI with GitHub.com or GitHub Enterprise so other gh commands can run.
- gh pr createCreate a pull request from the current branch with title, body, reviewers, and base branch options.
- gitTrack source history and collaborate through distributed repositories.
- gh repo cloneClone a GitHub repository to your machine using your authenticated gh settings.
FAQ
What does gh pr checks do in GitHub CLI?
Show GitHub Actions and status-check results for a pull request.
Does gh pr checks work on Windows and Linux?
Yes. The GitHub CLI (`gh`) runs on Linux, Windows, and macOS with the same subcommand syntax after you authenticate with `gh auth login`.
What is a practical gh pr checks example?
Try `gh pr checks` — Lists check names and pass/fail state.
Do I need a token in the command line for gh pr checks?
Prefer `gh auth login` so credentials stay in the system keyring or secure storage. Avoid pasting personal access tokens into shell history.
Browse the full Linux and Windows command reference to search more bash, CMD, PowerShell, Conda, and GitHub CLI commands.