gh-ruleset(1)

gh-ruleset1

View info about repo rulesets

Usage

gh ruleset <command> [flags]

Overview

Repository rulesets are a way to define a set of rules that apply to a repository. These commands allow you to view information about them.

Available commands

gh-ruleset-check(1)

View rules that would apply to a given branch

gh-ruleset-list(1)

List rulesets for a repository or organization

gh-ruleset-view(1)

View information about a ruleset

Options

-R, --repo <[HOST/]OWNER/REPO>

Select another repository using the [HOST/]OWNER/REPO format

Aliases

gh rs

Exit status

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.

Examples

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

Releases

2 releases since Debian 13 (Trixie); the text changed 1 time.

  1. 13
  2. Arch

From github-cli 2.102.1-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.