Skip to content

Document 'tt cfg dump' #3722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions doc/reference/tooling/tt_cli/cfg.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Environment configuration
=========================

.. code-block:: bash

tt cfg COMMAND [command flags]

``tt cfg`` manages a ``tt`` environment :ref:`configuration <tt-config_file>`.


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
3 changes: 3 additions & 0 deletions doc/reference/tooling/tt_cli/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ help for the given command.
- Build an application locally
* - :doc:`cat <cat>`
- Print the contents of ``.snap`` or ``.xlog`` files into stdout
* - :doc:`cfg <cfg>`
- Manage a ``tt`` environment configuration
* - :doc:`check <check>`
- Check an application file for syntax errors
* - :doc:`clean <clean>`
Expand Down Expand Up @@ -64,6 +66,7 @@ help for the given command.

build <build>
cat <cat>
cfg <cfg>
check <check>
clean <clean>
completion <completion>
Expand Down