From 499e7d5c7e65db1591f1b59366906a62bb72cb46 Mon Sep 17 00:00:00 2001 From: andreyaksenov Date: Mon, 18 Sep 2023 14:56:18 +0300 Subject: [PATCH] Document 'tt cfg' --- doc/reference/tooling/tt_cli/cfg.rst | 35 +++++++++++++++++++++++ doc/reference/tooling/tt_cli/commands.rst | 3 ++ 2 files changed, 38 insertions(+) create mode 100644 doc/reference/tooling/tt_cli/cfg.rst diff --git a/doc/reference/tooling/tt_cli/cfg.rst b/doc/reference/tooling/tt_cli/cfg.rst new file mode 100644 index 0000000000..ef39b545d4 --- /dev/null +++ b/doc/reference/tooling/tt_cli/cfg.rst @@ -0,0 +1,35 @@ +Environment configuration +========================= + +.. code-block:: bash + + tt cfg COMMAND [command flags] + +``tt cfg`` manages a ``tt`` environment :ref:`configuration `. + + +Commands +-------- + +.. container:: table + + .. list-table:: + :widths: 20 80 + :header-rows: 0 + + * - ``dump`` + - Print a ``tt`` environment configuration. + + Flags: + + * ``-r``, ``--raw``: Print a raw content of the ``tt.yaml`` configuration file. + + +Examples +-------- + +The following command prints a ``tt`` environment configuration: + +.. code-block:: bash + + tt cfg dump diff --git a/doc/reference/tooling/tt_cli/commands.rst b/doc/reference/tooling/tt_cli/commands.rst index 87987dda0f..21d1d53dac 100644 --- a/doc/reference/tooling/tt_cli/commands.rst +++ b/doc/reference/tooling/tt_cli/commands.rst @@ -16,6 +16,8 @@ help for the given command. - Build an application locally * - :doc:`cat ` - Print the contents of ``.snap`` or ``.xlog`` files into stdout + * - :doc:`cfg ` + - Manage a ``tt`` environment configuration * - :doc:`check ` - Check an application file for syntax errors * - :doc:`clean ` @@ -64,6 +66,7 @@ help for the given command. build cat + cfg check clean completion