@mastra/mcp-docs-server 1.1.4 → 1.1.5-alpha.0

package/.docs/reference/cli/mastra.md

@@ -1,336 +0,0 @@
-# CLI Commands
-
-You can use the Command-Line Interface (CLI) provided by Mastra to develop, build, and start your Mastra project.
-
-## `mastra dev`
-
-Starts a server which exposes [Studio](https://mastra.ai/docs/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit <http://localhost:4111/swagger-ui> for an overview of all available endpoints once `mastra dev` is running.
-
-You can also [configure the server](https://mastra.ai/docs/getting-started/studio).
-
-### Flags
-
-The command accepts [common flags](#common-flags) and the following additional flags:
-
-#### `--https`
-
-Enable local HTTPS support. [Learn more](https://mastra.ai/reference/configuration).
-
-#### `--inspect`
-
-Start the development server in inspect mode, helpful for debugging. Optionally specify a custom host and port (e.g., `--inspect=0.0.0.0:9229` for Docker). This can't be used together with `--inspect-brk`.
-
-#### `--inspect-brk`
-
-Start the development server in inspect mode and break at the beginning of the script. Optionally specify a custom host and port (e.g., `--inspect-brk=0.0.0.0:9229`). This can't be used together with `--inspect`.
-
-#### `--custom-args`
-
-Comma-separated list of custom arguments to pass to the Node.js process, e.g. `--require=newrelic` or `--experimental-transform-types`.
-
-#### `--request-context-presets`
-
-Path to a JSON file containing named [request context](https://mastra.ai/docs/server/request-context) presets. When provided, a dropdown appears in Studio's request context editor, letting you quickly switch between preset configurations.
-
-```bash
-mastra dev --request-context-presets ./presets.json
-```
-
-The file must be a JSON object where each key is a preset name and each value is an object:
-
-```json
-{
-  "development": { "userId": "dev-user", "env": "development" },
-  "production": { "userId": "prod-user", "env": "production" }
-}
-```
-
-### Configs
-
-You can set certain environment variables to modify the behavior of `mastra dev`.
-
-#### Skip peer dependency check
-
-Set `MASTRA_SKIP_PEERDEP_CHECK=1` to skip the peer dependency version mismatch check at startup:
-
-```bash
-MASTRA_SKIP_PEERDEP_CHECK=1 mastra dev
-```
-
-This is useful during monorepo development when peer dependencies may be bumped but packages are not yet published.
-
-#### Disable build caching
-
-Set `MASTRA_DEV_NO_CACHE=1` to force a full rebuild rather than using the cached assets under `.mastra/`:
-
-```bash
-MASTRA_DEV_NO_CACHE=1 mastra dev
-```
-
-This helps when you are debugging bundler plugins or suspect stale output.
-
-#### Limit parallelism
-
-`MASTRA_CONCURRENCY` caps how many expensive operations run in parallel (primarily build and evaluation steps). For example:
-
-```bash
-MASTRA_CONCURRENCY=4 mastra dev
-```
-
-Leave it unset to let the CLI pick a sensible default for the machine.
-
-#### Custom provider endpoints
-
-When using providers supported by the Vercel AI SDK you can redirect requests through proxies or internal gateways by setting a base URL. For OpenAI:
-
-```bash
-OPENAI_API_KEY=<your-api-key> \
-OPENAI_BASE_URL=https://openrouter.example/v1 \
-mastra dev
-```
-
-For Anthropic:
-
-```bash
-ANTHROPIC_API_KEY=<your-api-key> \
-ANTHROPIC_BASE_URL=https://anthropic.internal \
-mastra dev
-```
-
-These are forwarded to the Mastra model router and will work with any `"openai/..."` or `"anthropic/..."` model selections.
-
-## `mastra build`
-
-The `mastra build` command bundles your Mastra project into a production-ready Hono server. [Hono](https://hono.dev/) is a lightweight, type-safe web framework that makes it easy to deploy Mastra agents as HTTP endpoints with middleware support.
-
-Under the hood Mastra's Rollup server locates your Mastra entry file and bundles it to a production-ready Hono server. During that bundling it tree-shakes your code and generates source maps for debugging.
-
-The output in `.mastra` can be deployed to any cloud server using [`mastra start`](#mastra-start).
-
-If you're deploying to a [serverless platform](https://mastra.ai/docs/deployment/cloud-providers) you need to install the correct deployer in order to receive the correct output in `.mastra`.
-
-It accepts [common flags](#common-flags).
-
-### Flags
-
-#### `--studio`
-
-Bundle the Studio UI with the build.
-
-### Configs
-
-You can set certain environment variables to modify the behavior of `mastra build`.
-
-#### Skip peer dependency check
-
-Set `MASTRA_SKIP_PEERDEP_CHECK=1` to skip the peer dependency version mismatch check:
-
-```bash
-MASTRA_SKIP_PEERDEP_CHECK=1 mastra build
-```
-
-#### Limit parallelism
-
-For CI or when running in resource constrained environments you can cap how many expensive tasks run at once by setting `MASTRA_CONCURRENCY`.
-
-```bash
-MASTRA_CONCURRENCY=2 mastra build
-```
-
-## `mastra start`
-
-> **Info:** You need to run `mastra build` before using `mastra start`.
-
-Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing](https://mastra.ai/docs/observability/tracing/overview) is enabled.
-
-### Flags
-
-The command accepts [common flags](#common-flags) and the following additional flags:
-
-#### `--dir`
-
-The path to your built Mastra output directory. Defaults to `.mastra/output`.
-
-#### `--custom-args`
-
-Comma-separated list of custom arguments to pass to the Node.js process, e.g. `--require=newrelic` or `--experimental-transform-types`.
-
-## `mastra studio`
-
-Starts [Mastra Studio](https://mastra.ai/docs/getting-started/studio) as a static server. After starting, you can enter your Mastra instance URL (e.g. `http://localhost:4111`) to connect Studio to your Mastra backend. Looks for `.env` and `.env.production` files in the current working directory for configuration.
-
-### Flags
-
-The command accepts [common flags](#common-flags) and the following additional flags:
-
-#### `--port`
-
-The port to run Studio on. Defaults to `3000`.
-
-#### `--server-host`
-
-The host of the Mastra API server to connect to. Defaults to `localhost`.
-
-#### `--server-port`
-
-The port of the Mastra API server to connect to. Defaults to `4111`.
-
-#### `--server-protocol`
-
-The protocol of the Mastra API server to connect to. Defaults to `http`.
-
-#### `--request-context-presets`
-
-Path to a JSON file containing named [request context](https://mastra.ai/docs/server/request-context) presets. Works the same as the [`mastra dev` flag](#--request-context-presets).
-
-```bash
-mastra studio --request-context-presets ./presets.json
-```
-
-## `mastra lint`
-
-The `mastra lint` command validates the structure and code of your Mastra project to ensure it follows best practices and is error-free.
-
-It accepts [common flags](#common-flags).
-
-## `mastra scorers`
-
-The `mastra scorers` command provides management capabilities for evaluation scorers that measure the quality, accuracy, and performance of AI-generated outputs.
-
-Read the [Scorers overview](https://mastra.ai/docs/evals/overview) to learn more.
-
-### `add`
-
-Add a new scorer to your project. You can use an interactive prompt:
-
-```bash
-mastra scorers add
-```
-
-Or provide a scorer name directly:
-
-```bash
-mastra scorers add answer-relevancy
-```
-
-Use the [`list`](#list) command to get the correct ID.
-
-### `list`
-
-List all available scorer templates. Use the ID for the `add` command.
-
-## `mastra init`
-
-The `mastra init` command initializes Mastra in an existing project. Use this command to scaffold the necessary folders and configuration without generating a new project from scratch.
-
-### Flags
-
-The command accepts the following additional flags:
-
-#### `--default`
-
-Creates files inside `src` using OpenAI. It also populates the `src/mastra` folders with example code.
-
-#### `--dir`
-
-The directory where Mastra files should be saved to. Defaults to `src`.
-
-#### `--components`
-
-Comma-separated list of components to add. For each component a new folder will be created. Choose from: `"agents" | "tools" | "workflows" | "scorers"`. Defaults to `['agents', 'tools', 'workflows']`.
-
-#### `--llm`
-
-Default model provider. Choose from: `"openai" | "anthropic" | "groq" | "google" | "cerebras" | "mistral"`.
-
-#### `--llm-api-key`
-
-The API key for your chosen model provider. Will be written to an environment variables file (`.env`).
-
-#### `--example`
-
-If enabled, example code is written to the list of components (e.g. example agent code).
-
-#### `--no-example`
-
-Do not include example code. Useful when using the `--default` flag.
-
-#### `--mcp`
-
-Configure your code editor with Mastra's MCP server. Choose from: `"cursor" | "cursor-global" | "windsurf" | "vscode"`.
-
-## `mastra migrate`
-
-Runs database migrations to update your storage schema. This command is useful when upgrading Mastra versions that include storage schema changes.
-
-The command bundles your project, connects to your configured storage backend, and executes any pending migrations. Currently supports:
-
-- **Duplicate spans migration**: Removes duplicate `(traceId, spanId)` entries and adds a unique constraint to ensure data integrity.
-
-```bash
-mastra migrate
-```
-
-See the [Storage migration guide](https://mastra.ai/guides/migrations/upgrade-to-v1/storage) for details on when migrations are needed.
-
-It accepts [common flags](#common-flags).
-
-## Common flags
-
-### `--dir`
-
-**Available in:** `dev`, `build`, `lint`, `migrate`
-
-The path to your Mastra folder. Defaults to `src/mastra`.
-
-### `--debug`
-
-**Available in:** `dev`, `build`, `migrate`
-
-Enable verbose logging for Mastra's internals. Defaults to `false`.
-
-### `--env`
-
-**Available in:** `dev`, `start`, `studio`, `migrate`
-
-Custom environment variables file to include. By default, includes `.env.development`, `.env.local`, and `.env`.
-
-### `--root`
-
-**Available in:** `dev`, `build`, `lint`, `migrate`
-
-Path to your root folder. Defaults to `process.cwd()`.
-
-### `--tools`
-
-**Available in:** `dev`, `build`, `lint`
-
-Comma-separated list of tool paths to include. Defaults to `src/mastra/tools`.
-
-## Global flags
-
-Use these flags to get information about the `mastra` CLI.
-
-### `--version`
-
-Prints the Mastra CLI version and exits.
-
-### `--help`
-
-Prints help message and exits.
-
-## Telemetry
-
-By default, Mastra collects anonymous information about your project like your OS, Mastra version or Node.js version. You can read the [source code](https://github.com/mastra-ai/mastra/blob/main/packages/cli/src/analytics/index.ts) to check what's collected.
-
-You can opt out of the CLI analytics by setting an environment variable:
-
-```bash
-MASTRA_TELEMETRY_DISABLED=1
-```
-
-You can also set this while using other `mastra` commands:
-
-```bash
-MASTRA_TELEMETRY_DISABLED=1 mastra dev
-```