Cartridge Command Line Interface | Tarantool
Check out the new release policy
Tarantool Cartridge Cartridge Command Line Interface

Cartridge Command Line Interface

Cartridge CLI latest release on GitHub Cartridge CLI build status on GitHub Actions

Control your Tarantool application instances via the command line.

  1. Install the following third-party tools:

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

  3. [For all platforms except macOS] If you build Tarantool from source, you need to set up the Tarantool packages repository manually:

    curl -L | 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!

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.