Skip to content

Commit

Permalink
Merge pull request #249 from sabaini/doc/cmd-template
Browse files Browse the repository at this point in the history
Add template for command reference
  • Loading branch information
Peter Matulis authored Oct 20, 2023
2 parents 66c2ae3 + a29eaff commit 20afeaa
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/reference/commands/.cmd-template
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 20afeaa

Please sign in to comment.