reference-template.md

Synopsis

<command> [OPTIONS] <ARG1> [ARG2]

<One paragraph: what the command/file/function does and when you'd reach for it. Link to the relevant Explanation page for the model.>

Options

Flag	Argument	Default	Description
--<flag-1>	<value>	none
--<flag-2>	none	false
--<flag-3>	<value>	auto

--<flag-1>

<Longer description if the flag has nuance. Acceptable values, interactions with other flags, edge cases.>

--<flag-2>

Examples

Most common use case

<command example>

Second most common use case

<command example>

Edge case worth showing

<command example>

Exit codes

Code	Meaning
0	Success
1
2

See also

• [](.md)