Add tt console docs

Author: p7nov

doc/reference/tooling/tt_cli/index.rst

@@ -27,6 +27,7 @@ concept explanation, and the ``tt`` command reference.
     global_options
     commands
     external_modules
+    tt_interactive_console
 
 ..  _tt-cli-environments:
 

doc/reference/tooling/tt_cli/tt_interactive_console.rst

@@ -5,22 +5,17 @@ tt interactive console
 
 Intro: tt connect. + take some desc from tarantool console page
 
-The ``tt`` utility features an interactive console
-
-??? relation to tarantool console :ref:`Tarantool interactive console <interactive_console>`
-??? node specific
-??? link from tt connect ref
-
-??? Sections: input and output?
-
-completion (after require)
+The ``tt`` utility features an command-line console that allows working interactively
+in the connected Tarantool instances. It is pretty similar to the :ref:`Tarantool interactive console <interactive_console>`,
+but allows connecting to any available instance (both local and remote) and provides
+wider formatting capabilities.
 
 .. _tt-interactive-console-enter:
 
 Entering the console
 --------------------
 
-To connect to a Tarantool instance using the ``tt`` console, run :ref:``tt connect <tt-connect>``.
+To connect to a Tarantool instance using the ``tt`` console, run :ref:`tt connect <tt-connect>`.
 Specify the instance URI and connection options, such as the username and the password,
 in the corresponding options.
 
@@ -32,7 +27,7 @@ in the corresponding options.
 
     192.168.10.10:3301>
 
-If connecting to an instance from the same ``tt`` environment, you can use the ``<application>:<instance>``
+When connecting to an instance from the same ``tt`` environment, you can use the ``<application>:<instance>``
 string instead of the URI:
 
 ..  code-block:: console
@@ -88,6 +83,8 @@ language, run ``\set language <language>``, for example:
 
         $ tt connect app:storage001 -l sql
 
+For Lua input, the tab-based autocompletion is available.
+
 .. set delimiter??
 
 .. _tt-interactive-console-output:
@@ -98,9 +95,9 @@ Console output
 By default, the ``tt`` console prints the output data in the YAML format, each
 tuple on the new line.
 
-.. code-block::console
+..  code-block:: console
 
-    myapp:instance001> box.space.bands:select { }
+    app:storage001> box.space.bands:select { }
     ---
     - - [1, 'Roxette', 1986]
       - [2, 'Scorpions', 1965]
@@ -110,13 +107,13 @@ tuple on the new line.
 You can switch to alternative output formats: Lua or human-readable tables using
 the ``\set output`` console command:
 
-.. code-block::console
+..  code-block:: console
 
-    myapp:instance001> \set output lua
-    myapp:instance001> box.space.bands:select { }
+    app:storage001> \set output lua
+    app:storage001> box.space.bands:select { }
     {{1, "Roxette", 1986}, {2, "Scorpions", 1965}, {3, "Ace of Base", 1987}};
-    myapp:instance001> \set output table
-    myapp:instance001> box.space.bands:select { }
+    app:storage001> \set output table
+    app:storage001> box.space.bands:select { }
     +------+-------------+------+
     | col1 | col2        | col3 |
     +------+-------------+------+
@@ -132,8 +129,8 @@ are arranged in columns instead of rows:
 
 .. code-block::console
 
-    myapp:instance001> \set output ttable
-    myapp:instance001> box.space.bands:select { }
+    app:storage001> \set output ttable
+    app:storage001> box.space.bands:select { }
     +------+---------+-----------+-------------+
     | col1 | 1       | 2         | 3           |
     +------+---------+-----------+-------------+
@@ -142,6 +139,15 @@ are arranged in columns instead of rows:
     | col3 | 1986    | 1965      | 1987        |
     +------+---------+-----------+-------------+
 
+.. note::
+
+    You can also specify the output format in the ``tt connect`` call using the
+    ``-x``/``--outputformat`` option.
+
+    ..  code-block:: console
+
+        $ tt connect app:storage001 -x table
+
 For ``table`` and ``ttable`` output, more customizations are possible with the
 following commands:
 
@@ -152,20 +158,20 @@ following commands:
 
 .. code-block::console
 
-    myapp:instance001> \set table_format jira
-    myapp:instance001> box.space.bands:select {}
+    app:storage001> \set table_format jira
+    app:storage001> box.space.bands:select {}
     | col1 | 1 | 2 | 3 |
     | col2 | Roxette | Scorpions | Ace of Base |
     | col3 | 1986 | 1965 | 1987 |
-    myapp:instance001> \set table_format default
-    myapp:instance001> \set graphics false
-    myapp:instance001> box.space.bands:select {}
+    app:storage001> \set table_format default
+    app:storage001> \set graphics false
+    app:storage001> box.space.bands:select {}
      col1  1        2          3
      col2  Roxette  Scorpions  Ace of Base
      col3  1986     1965       1987
 
-    myapp:instance001> \set table_column_width 6
-    myapp:instance001> box.space.bands:select {}
+    app:storage001> \set table_column_width 6
+    app:storage001> box.space.bands:select {}
      col1  1       2       3
      col2  Roxett  Scorpi  Ace of
            +e      +ons    + Base
@@ -177,26 +183,31 @@ following commands:
 Commands
 --------
 
-\help, ?
-~~~~~
+\\help, ?
+~~~~~~~~~
 
 Show help on the ``tt`` console.
 
-\quit, \q
-~~~~~~~~~
+\\quit, \\q
+~~~~~~~~~~~
 
 Quit the ``tt`` console.
 
-\set language {lua|sql}
-~~~~~~~~~~~~~~~~~~~~~~~
+\\shortcuts
+~~~~~~~~~~~
+
+Show available keyboard shortcuts
+
+\\set language {lua|sql}
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Set the input language: Lua or SQL.
 Possible values: ``lua`` (default), ``sql``.
 
 An analog of the :ref:``tt connect <tt-connect>`` option ``-l``/``--language``
 
-\set output [FORMAT], \x[l|t|T|y], \x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+\\set output FORMAT, \\x{l|t|T|y}, \\x
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Set the output format.
 Possible ``FORMAT`` values:
@@ -220,24 +231,35 @@ The format of ``table`` and ``ttable`` output can be adjusted using the :ref:`\s
 
 An analog of the :ref:``tt connect <tt-connect>`` option ``-x``/``--outputformat``
 
-\set table_format
-~~~~~~~~~~~~~~~~~
+\\set table_format
+~~~~~~~~~~~~~~~~~~
+
+Set the table format if the output format is ``table`` or ``ttable``.
+Possible values:
 
-Set the table format if the output format is ``table`` or ``ttable``:
-default, Markdown, or jira.
+*   ``default`` -- a pseudographics (ASCII) table.
+*   ``markdown`` -- a table in the Markdown format
+*   ``jira`` -- a Jira-compatible table
 
-\set graphics {true|false}, \x{g|G}
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+\\set graphics {true|false}, \\x{g|G}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Whether to print pseudographics for table cells if the output format is ``table`` or ``ttable``.
-Possible values: ``true`` and ``false``.
+Possible values: ``true`` (default) and ``false``.
 
-\set table_colum_width WIDTH, \xw WIDTH
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The shorthands are:
+
+*  ``\xG`` for ``true``
+*  ``\xg`` for ``false``
+
+\\set table_colum_width WIDTH, \\xw WIDTH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Set maximum printed width of a table cell content. If the length exceeds this value,
 it continues on the next line starting from +
 
+Shorthand: ``\xw``
+
 .. _tt-interactive-console-shortcuts:
 
 Shortcuts