GH-RULESET(1)

πŸ’… GH-RULESET(1) β€” the gh-ruleset glow-up

okay bestie, you're reading the manual page for gh-ruleset, straight out of the GitHub CLI manual (yes, that GitHub CLI manual) ✨


🌸 NAME

gh-ruleset β€” peek at info about repo rulesets πŸŽ€

✨ SYNOPSIS

gh ruleset <command> [flags]

πŸ’– DESCRIPTION

so, repo rulesets? they're literally a way to define a set of rules that apply to a repository. iconic behavior 🫢

and these commands? they let you view information about them. that's the whole vibe. no cap.

πŸ‘‘ AVAILABLE COMMANDS

  • gh-ruleset-check(1) β€” view the rules that would apply to a given branch. like a vibe check, but for branches 🌈
  • gh-ruleset-list(1) β€” list rulesets for a repository or organization. the full roster, bestie πŸ“‹
  • gh-ruleset-view(1) β€” view information about a ruleset. the deep dive πŸ”

⭐ OPTIONS

  • -R, --repo <[HOST/]OWNER/REPO> β€” select another repository using the [HOST/]OWNER/REPO format. yes, keep the brackets exactly like that, she's specific πŸ’…

πŸ¦‹ ALIASES

gh rs

short, sweet, main character energy. use it 😌

πŸ”₯ EXIT CODES

  • 0 β€” successful execution πŸŽ‰ slay
  • 1 β€” error 😭
  • 2 β€” command canceled πŸ™ˆ
  • 4 β€” authentication required πŸ” (go log in, bestie)
NOTE: specific commands may have additional exit codes. refer to the command's help for more information. fr fr, always check πŸ‘€

🌼 EXAMPLE

$ gh ruleset list
$ gh ruleset view --repo OWNER/REPO --web
$ gh ruleset check branch-name

three lil commands, all iconic ⭐

🧚 SEE ALSO

gh(1) β€” the parent, the origin story πŸ’œ


and that's the whole page! brought to you by GitHub CLI v2.102.0, dated Oct 2026 ✨ mwah, go check those rulesets bestie πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from