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

1. Install the following third-party tools:

   • git
   • unzip
   • gcc
   • cmake and make

2. Install Tarantool 1.10 or higher. You have two options here:

   • Install from a package
   • Build from source

3. [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

4. 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

5. 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!

Quick start

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.

Usage

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

• Enabling shell completion for Cartridge CLI
• Supported Cartridge CLI commands
• Cartridge application lifecycle
• Creating a Cartridge application from template
• Building the application locally
• Starting the application locally
• Stopping the application locally
• Checking instance status
• Entering a locally running instance
• Connecting to a locally running instance at a specific address
• Displaying logs
• Cleaning instance files
• Repairing the cluster
• Setting up replica sets
• Configuring failover
• Running admin functions
• Packaging your application
  • Building a distribution
  • Packing a TGZ
  • Packing an RPM or DEB distribution
  • Creating a Docker image of your app
  • Building in Docker
• Global flags
• Application instance paths
• Pre-build and post-build scripts