github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/site/reference/cli/TEMPLATE.md (about)

     1  ---
     2  title: "`cmd`"
     3  linkTitle: "cmd"
     4  type: docs
     5  description: >
     6  One line description of the command
     7  ---
     8  <!--mdtogo:Short
     9      One line description of the command
    10  -->
    11  
    12  Short description of the command. The command should be referred to verbatim and
    13  not be capitalized, for example `get`, `update`, `fn`.
    14  The documentation for each command should be focused and concise. Any fundamental
    15  concepts or concerns cutting across many command should be covered in the kpt book
    16  and the reference docs should provide deep links to the relevant content.
    17  Args, flags, and env vars should be listed in alphabetical order.
    18  
    19  ### Synopsis
    20  <!--mdtogo:Long-->
    21  ```
    22  kpt <cmd group> <cmd> <ARGS> [flags]
    23  ```
    24  
    25  #### Args
    26  ```
    27  EXAMPLE_ARG:
    28    Description of the arg. This should include information about whether the ARG
    29    is required and if it is not, what would be the default value. It should use
    30    correct grammar, including capitalization and punctuation.
    31  ```
    32  
    33  #### Flags
    34  ```
    35  --example-flag:
    36    Description of the flag, including the default value. It should use correct 
    37    grammar, including capitalization and punctuation.
    38  ```
    39  
    40  #### Env Vars
    41  ```
    42  EXAMPLE_ENV_VAR:
    43    Description of the env variable. It should use correct 
    44    grammar, including capitalization and punctuation.
    45  ```
    46  <!--mdtogo-->
    47  
    48  ### Examples
    49  
    50  <!--mdtogo:Examples-->
    51  ```shell
    52  # Examples of how to use the command. This should include the most common use-cases
    53  # and include an example where the local package argument is not provided.
    54  # The description of each example should use correct grammar, including capitalization
    55  # and punctuation.
    56  kpt <cmd group> <cmd> ...
    57  ```
    58  <!--mdtogo-->