Skip to content

Commit

Permalink
Add template for command reference
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Sabaini <[email protected]>
  • Loading branch information
sabaini committed Oct 20, 2023
1 parent 66c2ae3 commit b1177bc
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/reference/commands/.cmd-template.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
=========
``{cmd}``
=========

{cmd_help}

Usage:

.. code-block:: none
microceph {cmd} [flags]
microceph {cmd} [command]
Available commands:

.. code-block:: none
{subcmd} {subcmd_help}
Global options:

.. code-block:: none
-d, --debug Show all debug messages
-h, --help Print help
--state-dir Path to store state information
-v, --verbose Show all information messages
--version Print version number
``subcmd``
----------

{subcmd_help}


Usage:

.. code-block:: none
microceph {cmd} {subcmd} {params}
Flags:

.. code-block:: none
{flag} {flag_help}

0 comments on commit b1177bc

Please sign in to comment.