GH-RULESET-VIEW(1)
π gh-ruleset-view(1) β the GitHub CLI manual, bestie edition π
okay so real talk: this is gh ruleset view, and it's literally the glow-up reveal of your GitHub rulesets. it's part of the GitHub CLI manual and it's giving "let me show you what's actually going on with your rules" β¨
πΈ NAME πΈ
gh-ruleset-view β view info about a ruleset π
π¦ SYNOPSIS π¦
gh ruleset view [<ruleset-id>] [flags]
like, you can pass an ID, or you can pass zero IDs and let the vibes (and a prompt) decide. either way we're looking at a ruleset π
β¨ DESCRIPTION β¨
View information about a GitHub ruleset. that's it, that's the whole thing, and honestly? iconic.
If you don't give it an ID, no worries β an interactive prompt pops up and lets you choose the ruleset you wanna view. very "pick your main character" energy π«Ά
Now listen, --parents is the flag you're gonna want to know about. it controls whether rulesets configured at higher levels β the ones that also apply to the repository or organization you gave it β come along for the ride. The default is true. so by default you're getting the whole family tree, not just the immediate child π
π OPTIONS π
-o,--org<string> β organization name, for when the ID you handed over is an organization-level ruleset. org girls rise π-p,--parents(defaulttrue) β whether to include rulesets configured at higher levels that also apply. default istrue, so yep, they're coming π-w,--webβ open the ruleset in the browser. we love a quick tab moment π¦
π OPTIONS INHERITED FROM PARENT COMMANDS π
-R,--repo<[HOST/]OWNER/REPO> β select another repository using the[HOST/]OWNER/REPOformat. yes, that format, exactly that one, don't freelance it β¨
π₯ EXIT CODES π₯
0: Successful execution π1: Error π2: Command canceled π4: Authentication required π
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. (iykyk β always check the command's own help for the full tea β)
β EXAMPLE β
# Interactively choose a ruleset to view from all rulesets that apply to the current repository
$ gh ruleset view
# Interactively choose a ruleset to view from only rulesets configured in the current repository
$ gh ruleset view --no-parents
# View a ruleset configured in the current repository or any of its parents
$ gh ruleset view 43
# View a ruleset configured in a different repository or any of its parents
$ gh ruleset view 23 --repo owner/repo
# View an organization-level ruleset
$ gh ruleset view 23 --org my-org
look at those examples go. slay after slay π
π SEE ALSO π
gh-ruleset(1)β the whole ruleset family, go say hi π§
that's the page bestie, no cap, every detail intact π keep slaying, and remember: rulesets are your friends, not your enemies π
signed, sealed, delivered by GitHub CLI v2.102.0 β Oct 2026 ππ«Ά
π¦ where this page comes from
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms