1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
# How we document our command line syntax
## Literal text
Use plain text for parts of the command that cannot be changed.
_example:_
`gh help`
The argument help is required in this command.
## Placeholder values
Use angled brackets to represent a value the user must replace. No other expressions can be contained within the angled brackets.
_example:_
`gh pr view <issue-number>`
Replace `<issue-number>` with an issue number.
## Optional arguments
Place optional arguments in square brackets. Mutually exclusive arguments can be included inside square brackets if they are separated with vertical bars.
_example:_
`gh pr checkout [--web]`
The argument `--web` is optional.
`gh pr view [<number> | <url>]`
The `<number>` and `<url>` arguments are optional.
## Required mutually exclusive arguments
Place required mutually exclusive arguments inside braces, separate arguments with vertical bars.
_example:_
`gh pr {view | create}`
## Repeatable arguments
Ellipsis represent arguments that can appear multiple times.
_example:_
`gh pr close <pr-number>...`
## Variable naming
For multi-word variables use dash-case (all lower case with words separated by dashes)
_example:_
`gh pr checkout <issue-number>`
## Additional examples
_optional argument with placeholder:_
`command sub-command [<arg>]`
_required argument with mutually exclusive options:_
`command sub-command {<path> | <string> | literal}`
_optional argument with mutually exclusive options:_
`command sub-command [<path> | <string>]`
|
