1.2 KiB
How we document our command line syntax
Required 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
example:
gh pr view <issue-number>
Replace <issue-number> with an issue number
Optional arguments
Place optional arguments in square brackets
example:
gh pr checkout [--web]
The argument --web is optional.
Mutually exclusive arguments
Place 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>]