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

NAME

6       gh-ruleset-view - View information about a ruleset
7
8
9

SYNOPSIS

11       gh ruleset view [<ruleset-id>] [flags]
12
13
14

DESCRIPTION

16       View information about a GitHub ruleset.
17
18
19       If  no ID is provided, an interactive prompt will be used to choose the
20       ruleset to view.
21
22
23       Use the --parents flag to control whether rulesets configured at higher
24       levels  that  also  apply  to  the  provided repository or organization
25       should be returned. The default is true.
26
27
28

OPTIONS

30       -o, --org <string>
31              Organization name if the provided ID  is  an  organization-level
32              ruleset
33
34
35       -p, --parents
36              Whether  to  include  rulesets  configured at higher levels that
37              also apply
38
39
40       -w, --web
41              Open the ruleset in the browser
42
43
44

OPTIONS INHERITED FROM PARENT COMMANDS

46       -R, --repo <[HOST/]OWNER/REPO>
47              Select another repository using the [HOST/]OWNER/REPO format
48
49
50

EXAMPLE

52              # Interactively choose a ruleset to view from all rulesets that apply to the current repository
53              $ gh ruleset view
54
55              # Interactively choose a ruleset to view from only rulesets configured in the current repository
56              $ gh ruleset view --no-parents
57
58              # View a ruleset configured in the current repository or any of its parents
59              $ gh ruleset view 43
60
61              # View a ruleset configured in a different repository or any of its parents
62              $ gh ruleset view 23 --repo owner/repo
63
64              # View an organization-level ruleset
65              $ gh ruleset view 23 --org my-org
66
67
68
69
70

SEE ALSO

72       gh-ruleset(1)
73
74
75
76                                   Oct 2023                 GH-RULESET-VIEW(1)