gh-ruleset

gh ruleset command [flags]

gh ruleset manages GitHub repository and organization rulesets, which define branch and tag protection rules, required status checks, required reviews, deployment protections, and merge requirements. Rulesets are a more expressive replacement for classic branch protection rules.A ruleset can target multiple branches or tags using fnmatch patterns, apply across all repositories in an organization, and define bypass actors. The check command evaluates which rules currently apply to a specific branch, useful for understanding why a push or merge was rejected.Creating and editing rulesets is not supported directly from the CLI; use the GitHub web UI or the REST API via gh api.

-R, --repo \[HOST/\]OWNER/REPO

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

Operate on an organization's rulesets instead of a repository's.

Include inherited rulesets from parent organizations (list/view).

Maximum number of rulesets to list (default 30).

Open the ruleset in the browser (view).

Check rules for the repository's default branch (check).

check [branch]

Show rules that apply to a given branch in the current repository.

List rulesets for a repository or organization.

View information about a ruleset. Without an ID, runs interactively.

Requires authentication via gh auth login. Viewing organization rulesets requires organization permissions. Rules defined at the enterprise or organization level may not appear unless --parents is used.

gh(1), gh-api(1), gh-repo(1), gh-auth(1)