gh-ruleset-list(1)

1GH-RULESET-LIST(1)             GitHub CLI manual            GH-RULESET-LIST(1)
2
3
4

NAME

6       gh-ruleset-list - List rulesets for a repository or organization
7
8
9

SYNOPSIS

11       gh ruleset list [flags]
12
13
14

DESCRIPTION

16       List GitHub rulesets for a repository or organization.
17
18
19       If  no  options  are  provided,  the  current repository's rulesets are
20       listed. You can query a different repository's rulesets  by  using  the
21       --repo  flag.  You can also use the --org flag to list rulesets config‐
22       ured for the provided organization.
23
24
25       Use the --parents flag to control whether rulesets configured at higher
26       levels  that  also  apply  to  the  provided repository or organization
27       should be returned. The default is true.
28
29
30       Your access token must have the admin:org scope to use the --org  flag,
31       which can be granted by running "gh auth refresh -s admin:org".
32
33
34

OPTIONS

36       -L, --limit <int>
37              Maximum number of rulesets to list
38
39
40       -o, --org <string>
41              List organization-wide rulesets for the provided organization
42
43
44       -p, --parents
45              Whether  to  include  rulesets  configured at higher levels that
46              also apply
47
48
49       -w, --web
50              Open the list of rulesets in the web browser
51
52
53

OPTIONS INHERITED FROM PARENT COMMANDS

55       -R, --repo <[HOST/]OWNER/REPO>
56              Select another repository using the [HOST/]OWNER/REPO format
57
58
59

EXAMPLE

61       # List rulesets in the current repository
62       $ gh ruleset list
63
64       # List rulesets in a different repository, including those configured at higher levels
65       $ gh ruleset list --repo owner/repo --parents
66
67       # List rulesets in an organization
68       $ gh ruleset list --org org-name
69
70
71
72
73

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

EXAMPLE

SEE ALSO