HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

gh ruleset — Manage GitHub repository rulesets. More information: <https://cli.github.com/manual/gh_ruleset>.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
rulesetscommandgithubgh rulesetclimanagemorerepository

Problem

How to use the gh ruleset command: Manage GitHub repository rulesets. More information: <https://cli.github.com/manual/gh_ruleset>.

Solution

gh ruleset — Manage GitHub repository rulesets. More information: <https://cli.github.com/manual/gh_ruleset>.

List all rulesets for the current repository:
gh {{[rs|ruleset]}} {{[ls|list]}}


List all rulesets for a specific organization:
gh {{[rs|ruleset]}} {{[ls|list]}} {{[-o|--org]}} {{organization_name}}


Check the rules that apply to the current branch:
gh {{[rs|ruleset]}} check


Check the rules that apply to a specific branch in another repository:
gh {{[rs|ruleset]}} check {{branch_name}} {{[-R|--repo]}} {{owner}}/{{repository}}


Interactively select and view a ruleset for the current repository:
gh {{[rs|ruleset]}} view


View a specific ruleset by its ID:
gh {{[rs|ruleset]}} view {{ruleset_id}}


View an organization-level ruleset by its ID:
gh {{[rs|ruleset]}} view {{ruleset_id}} {{[-o|--org]}} {{organization_name}}


Open the list of rulesets for a specific repository in the browser:
gh {{[rs|ruleset]}} {{[ls|list]}} {{[-R|--repo]}} {{owner}}/{{repository}} {{[-w|--web]}}

Code Snippets

List all rulesets for the current repository

gh {{[rs|ruleset]}} {{[ls|list]}}

List all rulesets for a specific organization

gh {{[rs|ruleset]}} {{[ls|list]}} {{[-o|--org]}} {{organization_name}}

Check the rules that apply to the current branch

gh {{[rs|ruleset]}} check

Check the rules that apply to a specific branch in another repository

gh {{[rs|ruleset]}} check {{branch_name}} {{[-R|--repo]}} {{owner}}/{{repository}}

Interactively select and view a ruleset for the current repository

gh {{[rs|ruleset]}} view

Context

tldr-pages: common/gh ruleset

Revisions (0)

No revisions yet.