reference-template.md

June 1, 2026 ยท View on GitHub

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

FlagArgumentDefaultDescription
--<flag-1><value>none
--<flag-2>nonefalse
--<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

CodeMeaning
0Success
1
2

See also

  • [](.md)