GH-PR-STATUS(1)

✨ NAME ✨

okay so this is gh-pr-status(1) β€” the GitHub CLI manual page for gh-pr-status, aka the little command that shows you the status of all your relevant pull requests πŸ’…


🌸 SYNOPSIS 🌸

gh pr status [flags]

that's it. that's the whole vibe. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

bestie, it shows the status of relevant pull requests. that's the whole job and it does it beautifully.

the status gives you a summary of pull requests that includes stuff like pull request number, title, CI checks, reviews, etc. like a little dashboard of your whole PR life ✨

and if you're nosy (affectionate) and want more details on the CI checks specifically? run gh pr checks. it's giving "read the room, then read the logs" πŸ’€πŸ”₯


πŸŽ€ OPTIONS πŸŽ€

  • -c, --conflict-status β€” shows you the merge conflict status of each pull request, so you know exactly which ones are being messy πŸ™ˆ
  • -q, --jq <expression> β€” filters the JSON output using a jq expression. yes queen, query your own data πŸ”
  • --json <fields> β€” outputs JSON with whatever fields you specify. you pick, it ships πŸ’–
  • -t, --template <string> β€” formats the JSON output using a Go template; see "gh help formatting" for the deets ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • -R, --repo <[HOST/]OWNER/REPO> β€” selects another repository using the [HOST/]OWNER/REPO format. main character energy: you can just. go. to another repo πŸ‘‘

⭐ JSON FIELDS ⭐

these are the fields you can ask for, and yes you can copy them exactly as written, no cap:

additions, assignees, author, autoMergeRequest, baseRefName, baseRefOid,
body, changedFiles, closed, closedAt, closingIssuesReferences, comments,
commits, createdAt, deletions, files, fullDatabaseId, headRefName,
headRefOid, headRepository, headRepositoryOwner, id, isCrossRepository,
isDraft, labels, latestReviews, maintainerCanModify, mergeCommit,
mergeStateStatus, mergeable, mergedAt, mergedBy, milestone, number,
potentialMergeCommit, projectCards, projectItems, reactionGroups,
reviewDecision, reviewRequests, reviews, state, statusCheckRollup,
title, updatedAt, url

pick your faves, build your little JSON bouquet πŸ“πŸ§š


πŸ’€ EXIT CODES πŸ’€

  • 0: successful execution β€” slay, it worked πŸ’…
  • 1: error β€” something went sideways 😭
  • 2: command canceled β€” nvm bestie, it's fine 🫢
  • 4: authentication required β€” you gotta log in first, it's giving locked door πŸ”
NOTE: specific commands may have additional exit codes. refer to the command's help for more information. (iykyk β€” always check the help fr fr)

πŸ‘‘ SEE ALSO πŸ‘‘

  • gh-pr(1) β€” the parent command, the mothership, the icon herself ✨

and that's the page!! πŸ’– this was written from the GitHub CLI v2.102.0 manual, dated Oct 2026 β€” so if you're reading this from a different version era, go check your own local copy, mwah πŸŽ€πŸ¦‹πŸ’œ

πŸ“¦ where this page comes from