Skip to content

Commit 32e6d8d

Browse files
authored
Add tt installation instructions (#3333)
Resolves #3320
1 parent 524e910 commit 32e6d8d

File tree

2 files changed

+48
-9
lines changed

2 files changed

+48
-9
lines changed

doc/reference/tooling/tt_cli/index.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,11 @@ A multi-purpose tool for working with Tarantool from the command line, ``tt`` is
1111
a potential replacement for :ref:`tarantoolctl <tarantoolctl>`
1212
and :doc:`Cartridge CLI </book/cartridge/cartridge_cli/index>`.
1313

14-
.. warning::
14+
``tt`` is developed in its own `GitHub repository <https://github.com/tarantool/tt>`_.
15+
Here you can find its source code, the changelog, and usage examples.
1516

16-
As of Tarantool 2.10, ``tt`` is in the early development stage. It includes
17-
only basic functionality and may be unstable. We don't recommend using it
18-
in production environments. Check out the list of :doc:`supported commands <commands>`.
19-
20-
To use ``tt``, you need to build it from sources.
21-
See :doc:`Installation <installation>` for details.
17+
In this section, you will find instructions on ``tt`` installation and configuration,
18+
concept explanation, and the command reference.
2219

2320
.. toctree::
2421
:maxdepth: 1

doc/reference/tooling/tt_cli/installation.rst

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
11
Installation
22
============
33

4-
To install the ``tt`` command-line utility:
4+
To install the ``tt`` command-line utility, use a package manager -- ``yum``
5+
or ``apt``. If you need a specific ``tt`` build or use MacOS, you can build
6+
``tt`` from sources.
7+
8+
Using package managers
9+
----------------------
10+
11+
On Linux systems, you can install with ``yum`` or ``apt`` package managers from
12+
the ``tarantool/modules`` repository. Learn how to `add this repository
13+
<https://www.tarantool.io/en/download/os-installation/ubuntu/>`_.
14+
15+
The installation command looks like this:
16+
17+
* On Ubuntu:
18+
19+
.. code-block:: console
20+
21+
$ sudo apt-get install tt
22+
23+
* On CentOS:
24+
25+
.. code-block:: console
26+
27+
$ sudo yum install tt
28+
29+
Building from sources
30+
---------------------
31+
32+
.. note::
33+
34+
As of ``tt`` 1.0.0, there is no pre-built version for MacOS, so building
35+
from sources is the only supported way to install ``tt`` on it.
536

637
1. Install third-party software required for building ``tt``:
738

@@ -16,11 +47,22 @@ To install the ``tt`` command-line utility:
1647
1748
git clone https://github.com/tarantool/tt --recursive
1849
19-
3. Go to the ``tt/`` directory and build ``tt`` using mage:
50+
3. Go to the ``tt/`` directory:
2051

2152
.. code-block:: bash
2253
2354
cd tt
55+
56+
4. (Optional) Checkout a release tag to build a specific version:
57+
58+
.. code-block:: bash
59+
60+
git checkout tags/v1.0.0
61+
62+
5. Build ``tt`` using mage:
63+
64+
.. code-block:: bash
65+
2466
mage build
2567
2668
``tt`` will appear in the current directory.

0 commit comments

Comments
 (0)