Skip to content

arivie CLI

The @arivie/cli package provides the arivie command for scaffolding, building, and deploying Arivie projects.

Terminal window
pnpm add -D @arivie/cli
# or use directly
pnpm dlx arivie <command>

Scaffolds a new project. Creates arivie.config.ts, semantic/ directory stubs, and CLI wiring.

Terminal window
arivie init

Configures the database and owner identity. Creates the read-only DB role, runs Mastra Memory migrations, and performs the owner-identity smoke check.

Terminal window
arivie setup

Add components to an existing project. Subcommands:

SubcommandPurpose
add entity <name>Scaffold a new semantic-layer entity YAML
add schedule <name>Create a schedule file
add skill <name>Add an SOP skill from the built-in library
add ui <component>Add a React UI component (e.g., agent-chat)
Terminal window
arivie add entity orders
arivie add skill cohort-analysis
arivie add ui agent-chat

Validates the semantic layer. Checks entity YAML against the Zod schema, reports errors and warnings.

Terminal window
arivie lint

Runs the evaluation suite (golden-SQL probes, dogfood questions).

Terminal window
arivie eval

Starts a local development server with hot reload.

Terminal window
arivie dev

Builds the project for a target runtime. Generates the server or worker entry point and bundles with esbuild/rollup/vite.

Terminal window
arivie build --target node # Node.js server
arivie build --target cloudflare # Cloudflare Worker

Deploys the built project to the target platform.

Terminal window
arivie deploy

Generates TypeScript declarations from the semantic layer (entity name types for React consumers).

Terminal window
arivie types

Runs the MCP server in stdio mode for integration with Claude Desktop, Cursor, or other MCP clients.

Terminal window
arivie mcp
FlagDescription
--config <path>Path to arivie.config.ts (default: ./arivie.config.ts)