mastra

The Mastra CLI

The Mastra CLI enables you to get up and running with mastra quickly. It is not required to use mastra, but helpful for getting started and more advanced use cases.

Installing the Mastra CLI

npm i -g mastra

Setup

mastra init

Deployment

Mastra's data syncing infrastructure is designed for Next.js sites running on serverless hosting providers like Vercel or Netlify.

Logs are stored in Upstash.

Full deployment docs here.

Commands

mastra init

This creates a mastra directory under src containing an index.ts entrypoint and an agent directory containing two sample agents.

project-root/
├── src/
   ├── app/
   └── mastra/
       ├── agents/
       │   └── agents.ts
       └── index.ts

Agents

mastra agent new

This creates a new agent.

mastra agent list

This lists all available agents.

Engine

mastra engine add

This installs the @mastra/engine dependency to your project.

mastra engine generate

Generates the Drizzle database client and TypeScript types.

mastra engine migrate

This migrates the database forward. You might need to run this after updating mastra.

mastra engine up

This is a shortcut that runs the docker-compose up command using the mastra-pg.docker-compose.yaml file. This will spin up any local docker containers that mastra needs.

It is useful for cases where you don't have a dockerized postgres db setup.

Rest Endpoints

mastra dev

This spins up REST endpoints for all agents, all workflows, and memory.

Local development

1. clone the repo
2. Run pnpm i to install deps

Telemetry

This CLI collects anonymous usage data to help improve the tool. We collect:

• Commands used
• Command execution time
• Error occurrences
• System information (OS, Node version)

No personal or sensitive information is collected.

To opt-out of telemetry:

1. Add NO_MASTRA_TELEMETRY=1 to commands