Creating a tt environment | Tarantool
Reference Tooling tt CLI utility Commands Creating a tt environment

Creating a tt environment

$ tt init

tt init creates a tt environment in the current directory. This includes:

  • Setting up directories for working files: binaries, templates, and so on.
  • Creating a corresponding tt.yaml configuration file.


The Tarantool Cartridge framework is deprecated and is not compatible with Tarantool 3.0 and later. This command is added for backward compatibility with earlier versions.

tt init checks the existence of configuration files for Cartridge (cartridge.yml) or the tarantoolctl utility (.tarantoolctl) in the current directory. If such files are found, tt generates an environment that uses the same directories:

  • cartridge.yml – the directories specified in the file.

  • .tarantoolctl – the directories specified in the default_cfg table.


    init is the only tt command that invokes .tarantoolctl files. Thus, variables defined in this script will not be available in applications launched by a tt start call.

If there is no cartridge.yml or .tarantoolctl files in the current directory, tt init creates a default environment in it. This includes creating the following directories and files:

  • bin – the directory for storing binary files.
  • include – the directory for storing header files.
  • distfiles – the directory for storing installation files.
  • instances.enabled – the directory for storing running applications or symlinks.
  • modules – the directory for storing external modules.
  • tt.yaml – the configuration file.
  • templates – the directory for storing application templates.

Create a tt environment in the current directory:

$ tt init
Found what you were looking for?