Skip to content

Commit 6e504f4

Browse files
committed
Document 'tt cfg'
1 parent 72d51b2 commit 6e504f4

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

doc/reference/tooling/tt_cli/cfg.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Environment configuration
2+
=========================
3+
4+
.. code-block:: bash
5+
6+
tt cfg [flags] <command> [command flags]
7+
8+
``tt cfg`` manages a ``tt`` environment :ref:`configuration <tt-config_file>`.
9+
10+
.. NOTE::
11+
12+
To create a new ``tt`` environment in the current directory, use :ref:`tt init <tt-init>`.
13+
14+
Commands
15+
--------
16+
17+
.. container:: table
18+
19+
.. list-table::
20+
:widths: 20 80
21+
:header-rows: 0
22+
23+
* - ``dump``
24+
- Print a ``tt`` environment configuration.
25+
26+
Flags:
27+
28+
* ``-r``, ``--raw``: Print a raw content of the ``tt.yaml`` configuration file.
29+
30+
31+
Examples
32+
--------
33+
34+
The following command prints a ``tt`` environment configuration:
35+
36+
.. code-block:: bash
37+
38+
tt cfg dump

doc/reference/tooling/tt_cli/commands.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ help for the given command.
1616
- Build an application locally
1717
* - :doc:`cat <cat>`
1818
- Print the contents of ``.snap`` or ``.xlog`` files into stdout
19+
* - :doc:`cfg <cfg>`
20+
- Manage a ``tt`` environment configuration
1921
* - :doc:`check <check>`
2022
- Check an application file for syntax errors
2123
* - :doc:`clean <clean>`
@@ -64,6 +66,7 @@ help for the given command.
6466

6567
build <build>
6668
cat <cat>
69+
cfg <cfg>
6770
check <check>
6871
clean <clean>
6972
completion <completion>

0 commit comments

Comments
 (0)