Convex CLI

Convex CLI manages Convex backends from a local project directory. It handles dev syncing, deployment, function execution, data inspection, imports and exports, and environment management for cloud or local Convex deployments.

• Push backend code during local development, regenerate generated types, and deploy functions, schema, and indexes to dev, prod, or preview deployments.
• Run queries, mutations, and actions; tail logs; inspect table data; and read or update deployment environment variables from the shell.
• Import or export deployment data, inspect function metadata, and start Convex's built-in MCP server when an editor or agent setup needs it.

• Commands map cleanly to inspect and change loops around an existing Convex project, so agents can deploy, run, inspect, and verify without leaving the shell.
• Structured output exists where it matters, including convex data --format jsonArray|jsonLines, convex logs --jsonl, and JSON file output from convex function-spec --file.
• Can also plug into MCP-based editor setups through the built-in convex mcp start server, but the direct CLI remains the primary action surface.

• You need a configured Convex project plus login or deploy-key credentials before most cloud commands can run unattended.
• Some setup flows, especially first-run convex dev configuration and login, are interactive and tied to local project state.