mirror of
https://github.com/hashicorp/vault.git
synced 2025-12-25 19:31:14 +01:00
f439a1eece
* save progress * fix file name * save progress * save progress * remove uneeded subheader * Fix build error * fix another build error
23 lines
649 B
Markdown
23 lines
649 B
Markdown
|
|
We document CLI command arguments, options, and flags as partials:
|
|
|
|
- as a first step toward templatizing and autogenerating the CLI command pages.
|
|
- to make it easier to include and maintain elements shared across commands in
|
|
the same family.
|
|
- to make it easier to include and maintain elements shared across command
|
|
families.
|
|
- to make it easier to include information about standard flags on the command
|
|
pages.
|
|
|
|
|
|
Partial template for CLI elements (required elements use <required> in place of
|
|
a default value):
|
|
|
|
<a id="COMMAND-[arg | option | flag]-NAME" />
|
|
|
|
**`-NAME (TYPE : DEFAULT)`**
|
|
|
|
DESCRIPTION
|
|
|
|
**Example**: `EXAMPLE_OF_VALID_USE`
|