[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6},"actionData","errors","routes/docs",{"_7":8,"_9":10,"_11":12},"path","operations/index.mdx","markdownUrl","/llms.mdx/docs/operations/content.md","pageTree",{"_13":14,"_15":16},"$fumadocs_loader","page-tree","data",{"_17":18,"_19":20,"_21":22,"_23":24},"$id","root","name","Convoy Docs","children",[79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138],"fallback",{"_17":25,"_19":26,"_21":27},"fallback:root","Docs",[28,29,30,31,32,33],{"_34":35,"_19":73,"_18":-7,"_37":38,"_39":74,"_41":-7,"_21":75,"_17":76,"_44":77,"_46":-7},{"_34":35,"_19":67,"_18":-7,"_37":38,"_39":68,"_41":-7,"_21":69,"_17":70,"_44":71,"_46":-7},{"_34":35,"_19":61,"_18":-7,"_37":38,"_39":62,"_41":-7,"_21":63,"_17":64,"_44":65,"_46":-7},{"_34":35,"_19":55,"_18":-7,"_37":38,"_39":56,"_41":-7,"_21":57,"_17":58,"_44":59,"_46":-7},{"_34":35,"_19":49,"_18":-7,"_37":38,"_39":50,"_41":-7,"_21":51,"_17":52,"_44":53,"_46":-7},{"_34":35,"_19":36,"_18":-7,"_37":38,"_39":40,"_41":-7,"_21":42,"_17":43,"_44":45,"_46":-7},"type","folder","Using Convoy","defaultOpen",false,"description","The product surface — organizations, tasks, threads, and shortcuts.","collapsible",[],"fallback:using","$ref",{"_47":48},"icon","metaFile","using/meta.json","Reference","Catalogs and schemas — CLI commands, config file, env vars, MCP tools, glossary, roadmap.",[],"fallback:reference",{"_47":54},"reference/meta.json","Operations","Running a Convoy deployment day-to-day.",[],"fallback:operations",{"_47":60},"operations/meta.json","Deploy Convoy","Stand up a new Convoy instance — Convex backend, auth, web app, email, and the production checklist.",[],"fallback:deployment",{"_47":66},"deployment/meta.json","Contributing","Codebase map, tests, specs, CLI internals, and docs authoring.",[],"fallback:contributing",{"_47":72},"contributing/meta.json","CLI & AI integrations","Install and connect the Convoy CLI, wire up MCP and skills, and run agents safely.",[],"fallback:cli",{"_47":78},"cli/meta.json",{"_17":466,"_34":178,"_46":467,"_19":468},{"_17":461,"_34":140,"_19":462,"_39":463,"_46":-7,"_143":464,"_44":465},{"_17":456,"_34":140,"_19":457,"_39":458,"_46":-7,"_143":459,"_44":460},{"_17":451,"_34":140,"_19":452,"_39":453,"_46":-7,"_143":454,"_44":455},{"_17":446,"_34":140,"_19":447,"_39":448,"_46":-7,"_143":449,"_44":450},{"_17":444,"_34":178,"_46":445,"_19":61},{"_17":440,"_34":140,"_19":61,"_39":441,"_46":-7,"_143":442,"_44":443},{"_17":435,"_34":140,"_19":436,"_39":437,"_46":-7,"_143":438,"_44":439},{"_17":430,"_34":140,"_19":431,"_39":432,"_46":-7,"_143":433,"_44":434},{"_17":425,"_34":140,"_19":426,"_39":427,"_46":-7,"_143":428,"_44":429},{"_17":420,"_34":140,"_19":421,"_39":422,"_46":-7,"_143":423,"_44":424},{"_17":415,"_34":140,"_19":416,"_39":417,"_46":-7,"_143":418,"_44":419},{"_17":410,"_34":140,"_19":411,"_39":412,"_46":-7,"_143":413,"_44":414},{"_17":405,"_34":140,"_19":406,"_39":407,"_46":-7,"_143":408,"_44":409},{"_17":403,"_34":178,"_46":404,"_19":36},{"_17":399,"_34":140,"_19":36,"_39":400,"_46":-7,"_143":401,"_44":402},{"_17":394,"_34":140,"_19":395,"_39":396,"_46":-7,"_143":397,"_44":398},{"_17":389,"_34":140,"_19":390,"_39":391,"_46":-7,"_143":392,"_44":393},{"_17":384,"_34":140,"_19":385,"_39":386,"_46":-7,"_143":387,"_44":388},{"_17":379,"_34":140,"_19":380,"_39":381,"_46":-7,"_143":382,"_44":383},{"_17":374,"_34":140,"_19":375,"_39":376,"_46":-7,"_143":377,"_44":378},{"_17":372,"_34":178,"_46":373,"_19":73},{"_17":367,"_34":140,"_19":368,"_39":369,"_46":-7,"_143":370,"_44":371},{"_17":362,"_34":140,"_19":363,"_39":364,"_46":-7,"_143":365,"_44":366},{"_17":357,"_34":140,"_19":358,"_39":359,"_46":-7,"_143":360,"_44":361},{"_17":352,"_34":140,"_19":353,"_39":354,"_46":-7,"_143":355,"_44":356},{"_17":347,"_34":140,"_19":348,"_39":349,"_46":-7,"_143":350,"_44":351},{"_17":342,"_34":140,"_19":343,"_39":344,"_46":-7,"_143":345,"_44":346},{"_34":35,"_19":318,"_18":-7,"_37":38,"_39":319,"_41":264,"_21":320,"_17":321,"_44":322,"_46":-7},{"_17":313,"_34":140,"_19":314,"_39":315,"_46":-7,"_143":316,"_44":317},{"_17":308,"_34":140,"_19":309,"_39":310,"_46":-7,"_143":311,"_44":312},{"_17":303,"_34":140,"_19":304,"_39":305,"_46":-7,"_143":306,"_44":307},{"_17":298,"_34":140,"_19":299,"_39":300,"_46":-7,"_143":301,"_44":302},{"_34":35,"_19":262,"_18":-7,"_37":38,"_39":263,"_41":264,"_21":265,"_17":266,"_44":267,"_46":-7},{"_17":257,"_34":140,"_19":258,"_39":259,"_46":-7,"_143":260,"_44":261},{"_17":255,"_34":178,"_46":256,"_19":55},{"_17":8,"_34":140,"_19":55,"_39":252,"_46":-7,"_143":253,"_44":254},{"_17":247,"_34":140,"_19":248,"_39":249,"_46":-7,"_143":250,"_44":251},{"_17":242,"_34":140,"_19":243,"_39":244,"_46":-7,"_143":245,"_44":246},{"_17":237,"_34":140,"_19":238,"_39":239,"_46":-7,"_143":240,"_44":241},{"_17":232,"_34":140,"_19":233,"_39":234,"_46":-7,"_143":235,"_44":236},{"_17":227,"_34":140,"_19":228,"_39":229,"_46":-7,"_143":230,"_44":231},{"_17":222,"_34":140,"_19":223,"_39":224,"_46":-7,"_143":225,"_44":226},{"_17":217,"_34":140,"_19":218,"_39":219,"_46":-7,"_143":220,"_44":221},{"_17":212,"_34":140,"_19":213,"_39":214,"_46":-7,"_143":215,"_44":216},{"_17":210,"_34":178,"_46":211,"_19":67},{"_17":205,"_34":140,"_19":206,"_39":207,"_46":-7,"_143":208,"_44":209},{"_17":200,"_34":140,"_19":201,"_39":202,"_46":-7,"_143":203,"_44":204},{"_17":195,"_34":140,"_19":196,"_39":197,"_46":-7,"_143":198,"_44":199},{"_17":190,"_34":140,"_19":191,"_39":192,"_46":-7,"_143":193,"_44":194},{"_17":185,"_34":140,"_19":186,"_39":187,"_46":-7,"_143":188,"_44":189},{"_17":180,"_34":140,"_19":181,"_39":182,"_46":-7,"_143":183,"_44":184},{"_17":177,"_34":178,"_46":179,"_19":49},{"_17":172,"_34":140,"_19":173,"_39":174,"_46":-7,"_143":175,"_44":176},{"_17":167,"_34":140,"_19":168,"_39":169,"_46":-7,"_143":170,"_44":171},{"_17":162,"_34":140,"_19":163,"_39":164,"_46":-7,"_143":165,"_44":166},{"_17":157,"_34":140,"_19":158,"_39":159,"_46":-7,"_143":160,"_44":161},{"_17":152,"_34":140,"_19":153,"_39":154,"_46":-7,"_143":155,"_44":156},{"_17":147,"_34":140,"_19":148,"_39":149,"_46":-7,"_143":150,"_44":151},{"_17":139,"_34":140,"_19":141,"_39":142,"_46":-7,"_143":144,"_44":145},"reference/roadmap.mdx","page","Roadmap","Runtime, integration, and deployment status in one place.","url","/docs/reference/roadmap",{"_146":139},"file","reference/glossary.mdx","Glossary","One-sentence definitions for the terms Convoy uses internally and in the product UI.","/docs/reference/glossary",{"_146":147},"reference/mcp-tools.mdx","MCP tools","Full catalog of the tools the Convoy MCP server exposes, with inputs and notable return fields.","/docs/reference/mcp-tools",{"_146":152},"reference/environment-variables.mdx","Environment Variables","Reference for all environment variables, where each one belongs, and what it does.","/docs/reference/environment-variables",{"_146":157},"reference/config-toml.mdx","Config file (config.toml)","Schema for ~/.config/convoy/config.toml, profile resolution order, and environment-variable overrides.","/docs/reference/config-toml",{"_146":162},"reference/cli-commands.mdx","CLI command reference","Every convoy command and flag, derived from the CLI's own command definitions.","/docs/reference/cli-commands",{"_146":167},"reference/index.mdx","Reference overview","Catalogs and schemas — CLI commands, config file, env vars, MCP tools, glossary, and roadmap.","/docs/reference",{"_146":172},"_6","separator","","contributing/authoring-docs.mdx","Authoring docs","Edit and extend the Convoy docs site — where content lives, how the sidebar is configured, and what stays in sync with code.","/docs/contributing/authoring-docs",{"_146":180},"contributing/adding-a-runtime.mdx","Adding a runtime","Steps to land execution support for a new CLI runtime.","/docs/contributing/adding-a-runtime",{"_146":185},"contributing/cli-architecture-and-lifecycle.mdx","CLI architecture and lifecycle","System shape, session and thread lifecycle, claims/leases/retries, and the raw-to-normalized chunk pipeline.","/docs/contributing/cli-architecture-and-lifecycle",{"_146":190},"contributing/specs-first-workflow.mdx","Specs-First Workflow","Use the internal specs as the implementation source of truth before changing behavior.","/docs/contributing/specs-first-workflow",{"_146":195},"contributing/testing.mdx","Testing","Run and extend the main test suites in Convoy.","/docs/contributing/testing",{"_146":200},"contributing/index.mdx","Contributing overview","Repository map, conventions, and where contributor-facing documentation lives.","/docs/contributing",{"_146":205},"_5","","operations/faq.mdx","FAQ","Short answers to common Convoy usage, CLI, and deployment questions.","/docs/operations/faq",{"_146":212},"operations/debugging.mdx","Debugging","Symptom-indexed entry point for production issues. Routes to the subsystem-specific troubleshooting pages.","/docs/operations/debugging",{"_146":217},"operations/upgrading.mdx","Upgrading","Move a live Convoy deployment to a newer version of the code.","/docs/operations/upgrading",{"_146":222},"operations/backups-and-rollback.mdx","Backups and rollback","How to back up Convoy data, roll back a bad deploy, and avoid the migration traps.","/docs/operations/backups-and-rollback",{"_146":227},"operations/migrations.mdx","Migrations","How to run Convex data migrations safely in production.","/docs/operations/migrations",{"_146":232},"operations/monitoring-and-logs.mdx","Monitoring and logs","Where backend and CLI logs live, what to watch, and what to alert on.","/docs/operations/monitoring-and-logs",{"_146":237},"operations/scaling-and-limits.mdx","Scaling and limits","Levers for scaling Convoy CLI throughput, and the backpressure signals to watch.","/docs/operations/scaling-and-limits",{"_146":242},"operations/running-the-cli-long-term.mdx","Running the CLI long-term","Patterns for running convoy connect as a durable worker — dev container first, process supervisors as a fallback.","/docs/operations/running-the-cli-long-term",{"_146":247},"Running Convoy day-to-day — CLI workers, scaling levers, monitoring, migrations, backups, and upgrades.","/docs/operations",{"_146":8},"_4","","cli/troubleshooting.mdx","CLI troubleshooting","Diagnose common setup, auth, runtime, and profile issues in the Convoy CLI.","/docs/cli/troubleshooting",{"_146":257},"Dev container","Run AI CLIs in an isolated workspace with optional network restrictions.",true,[269,270,271,272,273],"cli/dev-container",{"_47":268},"cli/dev-container/meta.json",{"_17":294,"_34":140,"_19":262,"_39":295,"_46":-7,"_143":296,"_44":297},{"_17":289,"_34":140,"_19":290,"_39":291,"_46":-7,"_143":292,"_44":293},{"_17":284,"_34":140,"_19":285,"_39":286,"_46":-7,"_143":287,"_44":288},{"_17":279,"_34":140,"_19":280,"_39":281,"_46":-7,"_143":282,"_44":283},{"_17":274,"_34":140,"_19":275,"_39":276,"_46":-7,"_143":277,"_44":278},"cli/dev-container/troubleshooting.mdx","Dev container troubleshooting","Diagnose common dev container issues affecting Convoy profiles, MCP connectivity, and AI CLIs.","/docs/cli/dev-container/troubleshooting",{"_146":274},"cli/dev-container/convoy-and-ai-clis.mdx","Convoy and AI CLIs","Use the dev container with Convoy profiles, Claude Code, MCP config, and project-local AI setup.","/docs/cli/dev-container/convoy-and-ai-clis",{"_146":279},"cli/dev-container/use-in-your-project.mdx","Use in your project","Install the AI agent sandbox dev container template into any project with the Convoy CLI.","/docs/cli/dev-container/use-in-your-project",{"_146":284},"cli/dev-container/setup-and-modes.mdx","Setup and modes","Build the dev container, provide host environment variables, and choose between strict or open networking.","/docs/cli/dev-container/setup-and-modes",{"_146":289},"cli/dev-container/index.mdx","Use the project dev container to run AI CLIs inside an isolated development environment.","/docs/cli/dev-container",{"_146":294},"cli/isolation-options.mdx","Isolation options","Ways to isolate connected agents — from runtime sandboxes to containers, VMs, and OS-level options on macOS, Windows, and Linux.","/docs/cli/isolation-options",{"_146":298},"cli/security.mdx","Security model","What API keys grant, what a connected agent can do on your machine, and how to limit blast radius.","/docs/cli/security",{"_146":303},"cli/one-shot-commands.mdx","One-shot commands","Use the CLI as a scriptable interface for organizations, projects, agents, tasks, and artifacts.","/docs/cli/one-shot-commands",{"_146":308},"cli/skills.mdx","Skills","Install Convoy skills so AI clients work with your tasks in a consistent way.","/docs/cli/skills",{"_146":313},"MCP","Connect MCP-aware AI clients to Convoy tasks.",[324,325,326],"cli/mcp",{"_47":323},"cli/mcp/meta.json",{"_17":337,"_34":140,"_19":338,"_39":339,"_46":-7,"_143":340,"_44":341},{"_17":332,"_34":140,"_19":333,"_39":334,"_46":-7,"_143":335,"_44":336},{"_17":327,"_34":140,"_19":328,"_39":329,"_46":-7,"_143":330,"_44":331},"cli/mcp/troubleshooting.mdx","MCP troubleshooting","Diagnose common MCP setup, discovery, and project scoping problems.","/docs/cli/mcp/troubleshooting",{"_146":327},"cli/mcp/workflows-and-scoping.mdx","MCP workflows and scoping","Understand how MCP access maps to Convoy projects, profiles, and daily workflows.","/docs/cli/mcp/workflows-and-scoping",{"_146":332},"cli/mcp/index.mdx","Set up MCP","Expose Convoy tasks and project context to MCP-aware AI clients.","/docs/cli/mcp",{"_146":337},"cli/provider-keys.mdx","Model provider keys","Store Bedrock or Mantle credentials locally, or pin a Claude.ai subscription, and choose the Claude Code provider for each CLI profile.","/docs/cli/provider-keys",{"_146":342},"cli/profiles-paths-status.mdx","Profiles, paths, and status","Understand how the CLI resolves saved profiles and working directories.","/docs/cli/profiles-paths-status",{"_146":347},"cli/setup-and-connect.mdx","Setup and connect","Configure a CLI profile and start a long-running Convoy agent connection.","/docs/cli/setup-and-connect",{"_146":352},"cli/install.mdx","Install the CLI","Install the Convoy CLI from npm, or run it from a checkout.","/docs/cli/install",{"_146":357},"cli/api-keys.mdx","API keys","Create and manage the keys that authenticate the CLI and MCP integrations.","/docs/cli/api-keys",{"_146":362},"cli/index.mdx","CLI & AI integrations overview","The Convoy CLI is the bridge between the web app and your machine — live threads, MCP config, skills, and task scripting.","/docs/cli",{"_146":367},"_3","","using/keyboard-shortcuts.mdx","Keyboard shortcuts","Keyboard shortcuts available in the Convoy web app.","/docs/using/keyboard-shortcuts",{"_146":374},"using/ai-threads.mdx","AI threads","Persistent AI conversations that execute on a connected machine and stream back into the app.","/docs/using/ai-threads",{"_146":379},"using/comments-attachments-artifacts.mdx","Comments, attachments, and artifacts","The three kinds of context a task can collect, and when to use which.","/docs/using/comments-attachments-artifacts",{"_146":384},"using/tasks.mdx","Tasks","The core work item — refs, statuses, views, subtasks, and ordering.","/docs/using/tasks",{"_146":389},"using/organizations-and-members.mdx","Organizations, projects, and members","The Convoy access model — organizations, projects, roles, aliases, and invitations.","/docs/using/organizations-and-members",{"_146":394},"using/index.mdx","A tour of the product surface — organizations, projects, tasks, threads, and the context that hangs off them.","/docs/using",{"_146":399},"_2","","deployment/self-hosting-convex.mdx","Self-hosting Convex","Run Convoy fully on your own infrastructure with the bundled Docker Compose setup — walkthrough, environment matrix, and what you give up versus managed Convex.","/docs/deployment/self-hosting-convex",{"_146":405},"deployment/production-checklist.mdx","Production Checklist","A practical launch checklist for a Convoy deployment.","/docs/deployment/production-checklist",{"_146":410},"deployment/deploy-docs.mdx","Deploy the Docs Site","Build and deploy the Convoy documentation site.","/docs/deployment/deploy-docs",{"_146":415},"deployment/email-and-resend.mdx","Email and Resend","Configure transactional email delivery for invitations and onboarding flows.","/docs/deployment/email-and-resend",{"_146":420},"deployment/deploy-to-vercel.mdx","Deploy to Vercel","Deploy the Convoy Next.js web app to Vercel with integrated Convex deployment.","/docs/deployment/deploy-to-vercel",{"_146":425},"deployment/auth-and-clerk.mdx","Auth and Clerk","Configure Clerk as the authentication layer for Convoy deployments, including the JWT template and user sync flow.","/docs/deployment/auth-and-clerk",{"_146":430},"deployment/deploy-with-convex.mdx","Deploy the Convex Backend","Create a Convex deployment, configure environment variables, and push functions and schema.","/docs/deployment/deploy-with-convex",{"_146":435},"deployment/index.mdx","Stand up a new Convoy instance — what you are deploying and in what order.","/docs/deployment",{"_146":440},"_1","","quickstart-source.mdx","Quickstart: run from source","Clone the repo, start Convex + Next.js, and point the CLI at your local dev deployment.","/docs/quickstart-source",{"_146":446},"quickstart-join.mdx","Quickstart: join a deployment","Install the Convoy CLI, connect it to an existing deployment, and send your first AI thread.","/docs/quickstart-join",{"_146":451},"how-convoy-works.mdx","How Convoy works","The product model, the runtime model, and how a thread travels from the web app to your machine.","/docs/how-convoy-works",{"_146":456},"index.mdx","Introduction","Real-time project management with a local AI agent bridge.","/docs",{"_146":461},"_0","","Getting started"]

Operations

Pages

On this page