GH-PR-CHECKS(1)

💅 gh-pr-checks — like a vibe check but for your CI

Hey bestie, welcome to gh-pr-checks(1), straight out of the GitHub CLI manual. Ok so real talk: this is the command that tells you whether your pull request's checks are slaying or absolutely flopping. ✨

gh pr checks [<number> | <url> | <branch>] [flags]

---

🌸 DESCRIPTION 🌸

It shows you the CI status for one single pull request. That's it, that's the whole gig. 🎀

And here's the thing — if you don't pass an argument at all, it just quietly picks the pull request that belongs to the current branch. Like, it already knows. Main character energy fr.

When you use the --json flag, the output includes a bucket field — that's the little field that takes the state field and categorizes it into one of these: pass, fail, pending, skipping, or cancel. Bucket is lowkey the vibe check of your pipeline. 🪣

Also there are extra exit codes, and yes this matters:

• 8: checks are pending — they're still cooking, not done yet ⏳

---

✨ OPTIONS ✨

• --fail-fast — bails out of watch mode the first time a check fails. No point watching the rest of the ship sink, right? 😭
• -i, --interval <int> (default 10) — how many seconds between refreshes in watch mode. Default is 10, so it's looking every ten seconds like an impatient bestie refreshing their notifications.
• -q, --jq <expression> — filters the JSON output using a jq expression. So you can pull out exactly the part you care about. 💖
• --json <fields> — outputs JSON with the fields you specify. Pick your faves (list is down below 👇).
• --required — only shows the checks that are required. Hides the extra noise, keeps the stuff that actually blocks your merge.
• -t, --template <string> — formats the JSON output using a Go template; see gh help formatting. Cute custom layouts, no cap.
• --watch — watches the checks until they finish. Sit there. Stare at it. Refresh refresh refresh. 🫶
• -w, --web — pops open your web browser to show details about the checks. For when you need the full lore.

🧬 OPTIONS INHERITED FROM PARENT COMMANDS

• -R, --repo <[HOST/]OWNER/REPO> — picks a different repository using the [HOST/]OWNER/REPO format. Because sometimes you're being nosy about someone else's repo, and that's valid. 💅

---

🦋 JSON FIELDS 🦋

Here's the full menu of fields you can ask for with --json. Copy-paste ready, character for character:

bucket, completedAt, description, event, link, name, startedAt, state,
workflow

---

🌈 EXIT CODES 🌈

• 0: successful execution — iconic, everything worked 👑
• 1: error — something went sideways 💀
• 2: command canceled — you (or something) hit stop 🙈
• 4: authentication required — gotta log in first, bestie 🍓

NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. (Yes, that includes that 8 up there for pending checks — don't forget it.)

---

⭐ SEE ALSO ⭐

• gh-pr(1) — the parent command, go say hi 💜

---

Later bestie! 🧚 This page is from GitHub CLI v2.102.0, dated Oct 2026. 💖✨