Cartridge Command Line Interface
Control your Tarantool application instances via the command line.
Install the following third-party tools:
Install Tarantool 1.10 or higher. You have two options here:
[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
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:
Check the installation:
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:
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.
- Enabling shell completion for Cartridge CLI
- List of supported Cartridge CLI commands
- Cartridge application lifecycle
- Creating a Cartridge application from a template
- Building the application locally
- Starting the application locally
- Stopping the application locally
- Checking instance status
- Displaying logs
- Cleaning instance files
- Repairing a cluster
- Packaging your application
- Configuring an installed package
- Files to control build and packaging