Supra CLI

The Supra CLI provides tools to develop your project locally and deploy to the Supra Platform.

You can use the Supra CLI to run the entire Supra stack locally on your machine, simply by running supra init (to create a new local project) and then supra start.

The Supra CLI provides tools to develop your project locally, deploy to the Supra Platform, handle database migrations, and generate types directly from your database schema.

Installing the Supra CLI#

Updating the Supra CLI#

When a new version is released, you can update the CLI using the same methods.

If you have any Supra containers running locally, remember to restart them after upgrading to use the new features.

Running Supra locally#

The Supra CLI uses Docker containers to manage the local development stack. To get started,

• Install Docker Desktop

Inside the folder where you want to create your project, run:

This will create a new supra folder. It's safe to commit this folder to your version control system.

Now, to start the Supra stack, run:

This takes time on your first run because the CLI needs to download the Docker images to your local machine. The CLI includes the entire Supra toolset, and a few additional images that are useful for local development (like a local SMTP server and a database diff tool).

The local development environment includes Supra Studio, a graphical interface for working with your database, running by default on localhost:54323.

Stopping local services#

When you are finished working on your Supra project, you can stop the stack with:

Full command reference#

The CLI provides a number of commands to help you develop your project locally and deploy to the Supra Platform. You can find all commands inside the CLI Reference docs, including:

• Project and Organization management
• Database management
• Database migrations and Database Branching
• Database debugging tools
• Edge Function management
• Auth management
• Types Generators
• Testing