Cartridge Command Line Interface

Important

Cartridge CLI is deprecated in favor of tt CLI. Find the instructions on switching from Cartridge CLI to tt in Migration from Cartridge CLI to tt.

Control your Tarantool application instances via the command line.

Installation

Install the following third-party tools:
- git
- unzip
- gcc
- cmake and make
Install Tarantool 1.10 or higher. You have two options here:
- Install from a package
- Build from source
[For all platforms except macOS] If you build Tarantool from source, you need to set up the Tarantool packages repository manually:
```
curl -L https://tarantool.io/installer.sh | sudo -E bash -s -- --repo-only
```
Install the cartridge-cli package:
- For CentOS, Fedora, or ALT Linux (RPM package):
```
sudo yum install cartridge-cli
```
- For Debian or Ubuntu (DEB package):
```
sudo apt-get install cartridge-cli
```
- For macOS (Homebrew formula):
```
brew install cartridge-cli
```
- Or build locally:
```
mage build
```
Check the installation:
```
cartridge version
```
You may see a warning: Project path is not a project. Don't worry, it only means there is no Cartridge application yet.

Now you can create and run your first application!

To create your first application, run:

cartridge create --name myapp

Go to the application directory:

cd myapp

Build and start your application:

cartridge build
cartridge start

Now open http://localhost:8081 and see your application's Admin Web UI:

You're all set! To dive right in, follow the Getting started with Cartridge guide.

For details about how to use Cartridge CLI, see the documentation links below.

Command-line utility to manage tarantool cartridge applications

Other

Language:Go 57.2%Language:Python 39.6%Language:Lua 2.6%Language:Shell 0.4%Language:Dockerfile 0.1%