Tarantool CLI¶
tt is the command-line utility for developing, packaging, deploying and
operating Tarantool applications.
Preview. This is the documentation of tt 3, which is not released yet, built from the
v3branch. tt 2.x is documented in the Tarantool documentation.
What tt does¶
- Develops an application as a package:
app.manifest.tomldeclares its dependencies and components,tt package buildbuilds them,tt runandtt testrun the code and the tests under the Tarantool of the project. - Runs the instances of an application on a host: Tarantool instances configured by the cluster config, Tarantool instances that run a script of their own, and external processes, all under a watchdog of tt, in the background, in the foreground or under systemd.
- Packages and installs an application:
tt package packmakes an archive with its dependencies and the Tarantool it runs on, andtt package installinstalls it for a user or system-wide, offline. - Manages the binaries an application runs on: Tarantool Community and Enterprise, tt, TCM and the Enterprise SDK, per project, per user or system-wide.
- Operates a cluster: its configuration, replica sets and failover, backups and point-in-time recovery.
- Runs WebAssembly components in Tarantool (experimental): code in Python, Go, Rust, C, JavaScript or C# built into the package and called from Lua; see Run WebAssembly components and An HTTP API in a WebAssembly component.
Try it¶
$ tt create cluster --name myapp
$ cd myapp
$ tt binary install tarantool
$ tt instance start
$ tt instance status
A cluster on your laptop walks through it.
Where to go¶
- What's new in tt 3: what tt 3 does that tt 2.x did not.
- Get started: install tt, run a cluster, make a package.
- Concepts: projects and scopes, packages, instances - the model the commands share.
- Write your application: a whole application, step by step.
- How-to: deploy, run under systemd, sign packages, extend tt, build a module in Rust, run WebAssembly components.
- Reference: every command, the files tt reads, the environment variables.
- Migrate from tt 2.x.