[{"_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",[150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210],"fallback",{"_17":25,"_19":26,"_21":27},"fallback:root","Docs",[28,29,30,31,32,33],{"_34":35,"_19":95,"_18":-7,"_37":38,"_39":96,"_41":-7,"_21":97,"_17":98,"_44":99,"_46":-7},{"_34":35,"_19":89,"_18":-7,"_37":38,"_39":90,"_41":-7,"_21":91,"_17":92,"_44":93,"_46":-7},{"_34":35,"_19":83,"_18":-7,"_37":38,"_39":84,"_41":-7,"_21":85,"_17":86,"_44":87,"_46":-7},{"_34":35,"_19":77,"_18":-7,"_37":38,"_39":78,"_41":-7,"_21":79,"_17":80,"_44":81,"_46":-7},{"_34":35,"_19":71,"_18":-7,"_37":38,"_39":72,"_41":-7,"_21":73,"_17":74,"_44":75,"_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",[49,50,51],"fallback:using","$ref",{"_47":48},"icon","metaFile","using/meta.json",{"_17":66,"_34":53,"_19":67,"_39":55,"_46":-7,"_56":68,"_44":69},{"_17":61,"_34":53,"_19":62,"_39":55,"_46":-7,"_56":63,"_44":64},{"_17":52,"_34":53,"_19":54,"_39":55,"_46":-7,"_56":57,"_44":58},"fallback:using/tasks.mdx","page","Tasks","This guide is now part of Working with projects and tasks.","url","/docs/using/tasks",{"_59":60},"file","using/tasks.mdx","fallback:using/organizations-and-members.mdx","Organizations, projects, and members","/docs/using/organizations-and-members",{"_59":65},"using/organizations-and-members.mdx","fallback:using/comments-attachments-artifacts.mdx","Comments, attachments, and artifacts","/docs/using/comments-attachments-artifacts",{"_59":70},"using/comments-attachments-artifacts.mdx","Reference","Catalogs and schemas — CLI commands, config file, env vars, MCP tools, glossary, roadmap.",[],"fallback:reference",{"_47":76},"reference/meta.json","Operations","Running a Convoy deployment day-to-day.",[],"fallback:operations",{"_47":82},"operations/meta.json","Deploy Convoy","Stand up a new Convoy instance — Convex backend, auth, web app, email, and the production checklist.",[],"fallback:deployment",{"_47":88},"deployment/meta.json","Contributing","Codebase map, tests, specs, CLI internals, and docs authoring.",[],"fallback:contributing",{"_47":94},"contributing/meta.json","CLI","Connect a machine, configure profiles, and run agents safely.",[101,102,103,104,105,106,107],"fallback:cli",{"_47":100},"cli/meta.json",{"_17":144,"_34":53,"_19":145,"_39":146,"_46":-7,"_56":147,"_44":148},{"_17":138,"_34":53,"_19":139,"_39":140,"_46":-7,"_56":141,"_44":142},{"_17":132,"_34":53,"_19":133,"_39":134,"_46":-7,"_56":135,"_44":136},{"_17":126,"_34":53,"_19":127,"_39":128,"_46":-7,"_56":129,"_44":130},{"_17":120,"_34":53,"_19":121,"_39":122,"_46":-7,"_56":123,"_44":124},{"_17":114,"_34":53,"_19":115,"_39":116,"_46":-7,"_56":117,"_44":118},{"_17":108,"_34":53,"_19":109,"_39":110,"_46":-7,"_56":111,"_44":112},"fallback:cli/setup-and-connect.mdx","Setup and connect","CLI setup has moved to Install and connect.","/docs/cli/setup-and-connect",{"_59":113},"cli/setup-and-connect.mdx","fallback:cli/remote-targets.mdx","Remote targets over SSH","Attach to and manage a Convoy service running on another machine.","/docs/cli/remote-targets",{"_59":119},"cli/remote-targets.mdx","fallback:cli/project-service.mdx","Persistent project service","Run registered Linux projects in the background and inspect their status and operational logs.","/docs/cli/project-service",{"_59":125},"cli/project-service.mdx","fallback:cli/managed-environments.mdx","Managed local environments","Start an isolated project environment and manage its service from your host terminal.","/docs/cli/managed-environments",{"_59":131},"cli/managed-environments.mdx","fallback:cli/isolated-projects.mdx","Isolated projects on Linux","Register multiple projects in one Linux VM, authenticate Codex separately, and test project isolation.","/docs/cli/isolated-projects",{"_59":137},"cli/isolated-projects.mdx","fallback:cli/install.mdx","Install the CLI","CLI installation has moved to Install and connect.","/docs/cli/install",{"_59":143},"cli/install.mdx","fallback:cli/browser-automation.mdx","Browser automation","Run a private Playwright browser in your devcontainer or Linux project.","/docs/cli/browser-automation",{"_59":149},"cli/browser-automation.mdx",{"_17":538,"_34":252,"_46":539,"_19":540},{"_17":533,"_34":53,"_19":534,"_39":535,"_46":-7,"_56":536,"_44":537},{"_17":528,"_34":53,"_19":529,"_39":530,"_46":-7,"_56":531,"_44":532},{"_17":523,"_34":53,"_19":524,"_39":525,"_46":-7,"_56":526,"_44":527},{"_17":518,"_34":53,"_19":519,"_39":520,"_46":-7,"_56":521,"_44":522},{"_17":516,"_34":252,"_46":517,"_19":36},{"_17":511,"_34":53,"_19":512,"_39":513,"_46":-7,"_56":514,"_44":515},{"_17":506,"_34":53,"_19":507,"_39":508,"_46":-7,"_56":509,"_44":510},{"_17":501,"_34":53,"_19":502,"_39":503,"_46":-7,"_56":504,"_44":505},{"_17":496,"_34":53,"_19":497,"_39":498,"_46":-7,"_56":499,"_44":500},{"_17":491,"_34":53,"_19":492,"_39":493,"_46":-7,"_56":494,"_44":495},{"_17":486,"_34":53,"_19":487,"_39":488,"_46":-7,"_56":489,"_44":490},{"_17":481,"_34":53,"_19":482,"_39":483,"_46":-7,"_56":484,"_44":485},{"_17":479,"_34":252,"_46":480,"_19":95},{"_17":474,"_34":53,"_19":475,"_39":476,"_46":-7,"_56":477,"_44":478},{"_17":469,"_34":53,"_19":470,"_39":471,"_46":-7,"_56":472,"_44":473},{"_17":464,"_34":53,"_19":465,"_39":466,"_46":-7,"_56":467,"_44":468},{"_17":459,"_34":53,"_19":460,"_39":461,"_46":-7,"_56":462,"_44":463},{"_17":454,"_34":53,"_19":455,"_39":456,"_46":-7,"_56":457,"_44":458},{"_17":449,"_34":53,"_19":450,"_39":451,"_46":-7,"_56":452,"_44":453},{"_34":35,"_19":414,"_18":-7,"_37":38,"_39":415,"_41":374,"_21":416,"_17":417,"_44":418,"_46":-7},{"_17":409,"_34":53,"_19":410,"_39":411,"_46":-7,"_56":412,"_44":413},{"_17":404,"_34":53,"_19":405,"_39":406,"_46":-7,"_56":407,"_44":408},{"_17":401,"_34":252,"_46":402,"_19":403},{"_17":397,"_34":53,"_19":247,"_39":398,"_46":-7,"_56":399,"_44":400},{"_34":35,"_19":372,"_18":-7,"_37":38,"_39":373,"_41":374,"_21":375,"_17":376,"_44":377,"_46":-7},{"_17":367,"_34":53,"_19":368,"_39":369,"_46":-7,"_56":370,"_44":371},{"_17":362,"_34":53,"_19":363,"_39":364,"_46":-7,"_56":365,"_44":366},{"_17":360,"_34":252,"_46":361,"_19":83},{"_17":355,"_34":53,"_19":356,"_39":357,"_46":-7,"_56":358,"_44":359},{"_17":350,"_34":53,"_19":351,"_39":352,"_46":-7,"_56":353,"_44":354},{"_17":345,"_34":53,"_19":346,"_39":347,"_46":-7,"_56":348,"_44":349},{"_17":340,"_34":53,"_19":341,"_39":342,"_46":-7,"_56":343,"_44":344},{"_17":335,"_34":53,"_19":336,"_39":337,"_46":-7,"_56":338,"_44":339},{"_17":330,"_34":53,"_19":331,"_39":332,"_46":-7,"_56":333,"_44":334},{"_17":325,"_34":53,"_19":326,"_39":327,"_46":-7,"_56":328,"_44":329},{"_17":323,"_34":252,"_46":324,"_19":77},{"_17":8,"_34":53,"_19":77,"_39":320,"_46":-7,"_56":321,"_44":322},{"_17":315,"_34":53,"_19":316,"_39":317,"_46":-7,"_56":318,"_44":319},{"_17":310,"_34":53,"_19":311,"_39":312,"_46":-7,"_56":313,"_44":314},{"_17":305,"_34":53,"_19":306,"_39":307,"_46":-7,"_56":308,"_44":309},{"_17":300,"_34":53,"_19":301,"_39":302,"_46":-7,"_56":303,"_44":304},{"_17":295,"_34":53,"_19":296,"_39":297,"_46":-7,"_56":298,"_44":299},{"_17":290,"_34":53,"_19":291,"_39":292,"_46":-7,"_56":293,"_44":294},{"_17":288,"_34":252,"_46":289,"_19":71},{"_17":284,"_34":53,"_19":247,"_39":285,"_46":-7,"_56":286,"_44":287},{"_17":279,"_34":53,"_19":280,"_39":281,"_46":-7,"_56":282,"_44":283},{"_17":274,"_34":53,"_19":275,"_39":276,"_46":-7,"_56":277,"_44":278},{"_17":269,"_34":53,"_19":270,"_39":271,"_46":-7,"_56":272,"_44":273},{"_17":264,"_34":53,"_19":265,"_39":266,"_46":-7,"_56":267,"_44":268},{"_17":259,"_34":53,"_19":260,"_39":261,"_46":-7,"_56":262,"_44":263},{"_17":254,"_34":53,"_19":255,"_39":256,"_46":-7,"_56":257,"_44":258},{"_17":251,"_34":252,"_46":253,"_19":89},{"_17":246,"_34":53,"_19":247,"_39":248,"_46":-7,"_56":249,"_44":250},{"_17":241,"_34":53,"_19":242,"_39":243,"_46":-7,"_56":244,"_44":245},{"_17":236,"_34":53,"_19":237,"_39":238,"_46":-7,"_56":239,"_44":240},{"_17":231,"_34":53,"_19":232,"_39":233,"_46":-7,"_56":234,"_44":235},{"_17":226,"_34":53,"_19":227,"_39":228,"_46":-7,"_56":229,"_44":230},{"_17":221,"_34":53,"_19":222,"_39":223,"_46":-7,"_56":224,"_44":225},{"_17":216,"_34":53,"_19":217,"_39":218,"_46":-7,"_56":219,"_44":220},{"_17":211,"_34":53,"_19":212,"_39":213,"_46":-7,"_56":214,"_44":215},"deployment/deploy-docs.mdx","Publish the docs","Build and deploy the Convoy documentation site.","/docs/deployment/deploy-docs",{"_59":211},"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",{"_59":216},"contributing/adding-a-runtime.mdx","Adding a runtime","Steps to land execution support for a new CLI runtime.","/docs/contributing/adding-a-runtime",{"_59":221},"contributing/cli-architecture-and-lifecycle.mdx","CLI architecture","System shape, session and thread lifecycle, claims/leases/retries, and the raw-to-normalized chunk pipeline.","/docs/contributing/cli-architecture-and-lifecycle",{"_59":226},"contributing/testing.mdx","Testing","Run and extend the main test suites in Convoy.","/docs/contributing/testing",{"_59":231},"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",{"_59":236},"quickstart-source.mdx","Run from source","Clone the repo, start Convex + Next.js, and point the CLI at your local dev deployment.","/docs/quickstart-source",{"_59":241},"contributing/index.mdx","Overview","Repository map, conventions, and where contributor-facing documentation lives.","/docs/contributing",{"_59":246},"_7","separator","","reference/roadmap.mdx","Runtime support","Compare execution, approvals, steering, attachments, and isolation across runtimes.","/docs/reference/roadmap",{"_59":254},"reference/glossary.mdx","Glossary","Definitions of the terms used in Convoy's product and runtime documentation.","/docs/reference/glossary",{"_59":259},"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",{"_59":264},"reference/environment-variables.mdx","Environment Variables","Reference for all environment variables, where each one belongs, and what it does.","/docs/reference/environment-variables",{"_59":269},"reference/config-toml.mdx","Config file","Schema for ~/.config/convoy/config.toml, profile resolution order, and environment-variable overrides.","/docs/reference/config-toml",{"_59":274},"reference/cli-commands.mdx","CLI commands","Every convoy command and flag, derived from the CLI's own command definitions.","/docs/reference/cli-commands",{"_59":279},"reference/index.mdx","Catalogs and schemas — CLI commands, config file, env vars, MCP tools, glossary, and roadmap.","/docs/reference",{"_59":284},"_6","","operations/debugging.mdx","Debugging","Symptom-indexed entry point for production issues. Routes to the subsystem-specific troubleshooting pages.","/docs/operations/debugging",{"_59":290},"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",{"_59":295},"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",{"_59":300},"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",{"_59":305},"operations/migrations.mdx","Migrations","How to run Convex data migrations safely in production.","/docs/operations/migrations",{"_59":310},"operations/upgrading.mdx","Upgrading","Move a live Convoy deployment to a newer version of the code.","/docs/operations/upgrading",{"_59":315},"Running Convoy day-to-day — CLI workers, scaling levers, monitoring, migrations, backups, and upgrades.","/docs/operations",{"_59":8},"_5","","deployment/self-hosting-convex.mdx","Docker deployment","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",{"_59":325},"deployment/production-checklist.mdx","Production Checklist","A practical launch checklist for a Convoy deployment.","/docs/deployment/production-checklist",{"_59":330},"deployment/email-and-resend.mdx","Email and Resend","Configure transactional email delivery for invitations and onboarding flows.","/docs/deployment/email-and-resend",{"_59":335},"deployment/deploy-to-vercel.mdx","Web app","Deploy the Convoy Next.js web app to Vercel with integrated Convex deployment.","/docs/deployment/deploy-to-vercel",{"_59":340},"deployment/deploy-with-convex.mdx","Convex backend","Create a Convex deployment, configure environment variables, and push functions and schema.","/docs/deployment/deploy-with-convex",{"_59":345},"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",{"_59":350},"deployment/index.mdx","Choose deployment","Choose managed hosting or Docker, then configure authentication, the backend, and the web app.","/docs/deployment",{"_59":355},"_4","","cli/one-shot-commands.mdx","CLI scripting","Use the CLI as a scriptable interface for organizations, projects, agents, tasks, and artifacts.","/docs/cli/one-shot-commands",{"_59":362},"cli/skills.mdx","Client Skills","Install Convoy skills so AI clients work with your tasks in a consistent way.","/docs/cli/skills",{"_59":367},"MCP","Connect MCP-aware AI clients to Convoy tasks.",true,[379,380,381],"cli/mcp",{"_47":378},"cli/mcp/meta.json",{"_17":392,"_34":53,"_19":393,"_39":394,"_46":-7,"_56":395,"_44":396},{"_17":387,"_34":53,"_19":388,"_39":389,"_46":-7,"_56":390,"_44":391},{"_17":382,"_34":53,"_19":383,"_39":384,"_46":-7,"_56":385,"_44":386},"cli/mcp/troubleshooting.mdx","MCP troubleshooting","Diagnose common MCP setup, discovery, and project scoping problems.","/docs/cli/mcp/troubleshooting",{"_59":382},"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",{"_59":387},"cli/mcp/index.mdx","Connect an MCP client","Expose Convoy tasks and project context to MCP-aware AI clients.","/docs/cli/mcp",{"_59":392},"integrations.mdx","Connect an AI client to Convoy, install the task Skill, or automate work from a terminal.","/docs/integrations",{"_59":397},"_3","","Integrations","cli/troubleshooting.mdx","CLI troubleshooting","Diagnose common setup, auth, runtime, and profile issues in the Convoy CLI.","/docs/cli/troubleshooting",{"_59":404},"operations/running-the-cli-long-term.mdx","Persistent connections","Patterns for running convoy connect as a durable worker — dev container first, process supervisors as a fallback.","/docs/operations/running-the-cli-long-term",{"_59":409},"Dev container","Run AI CLIs in an isolated workspace with optional network restrictions.",[420,421,422,423,424],"cli/dev-container",{"_47":419},"cli/dev-container/meta.json",{"_17":445,"_34":53,"_19":414,"_39":446,"_46":-7,"_56":447,"_44":448},{"_17":440,"_34":53,"_19":441,"_39":442,"_46":-7,"_56":443,"_44":444},{"_17":435,"_34":53,"_19":436,"_39":437,"_46":-7,"_56":438,"_44":439},{"_17":430,"_34":53,"_19":431,"_39":432,"_46":-7,"_56":433,"_44":434},{"_17":425,"_34":53,"_19":426,"_39":427,"_46":-7,"_56":428,"_44":429},"cli/dev-container/troubleshooting.mdx","Troubleshooting","Diagnose common dev container issues affecting Convoy profiles, MCP connectivity, and AI CLIs.","/docs/cli/dev-container/troubleshooting",{"_59":425},"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",{"_59":430},"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",{"_59":435},"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",{"_59":440},"cli/dev-container/index.mdx","Use the project dev container to run AI CLIs inside an isolated development environment.","/docs/cli/dev-container",{"_59":445},"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",{"_59":449},"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",{"_59":454},"cli/provider-keys.mdx","Model provider keys","Manage isolated Codex and Claude Code API keys and legacy Claude providers locally.","/docs/cli/provider-keys",{"_59":459},"cli/api-keys.mdx","API keys","Set up unattended CLI access and manage user-scoped credentials.","/docs/cli/api-keys",{"_59":464},"cli/profiles-paths-status.mdx","Profiles and paths","Understand how the CLI resolves saved profiles and working directories.","/docs/cli/profiles-paths-status",{"_59":469},"cli/index.mdx","Install and connect","Install the CLI, log in with your browser, and run your first AI thread on your machine.","/docs/cli",{"_59":474},"_2","","using/keyboard-shortcuts.mdx","Keyboard shortcuts","Keyboard shortcuts available in the Convoy web app.","/docs/using/keyboard-shortcuts",{"_59":481},"using/workflows.mdx","Workflows","Build staged agent work, start it on your connection, and handle approvals and failed steps.","/docs/using/workflows",{"_59":486},"using/prompts.mdx","Prompts / Slash commands","Save reusable messages and choose how they expand or submit in the thread composer.","/docs/using/prompts",{"_59":491},"using/skills.mdx","Skills in Convoy","Author instruction bundles, install organization templates, and use project Skills in threads.","/docs/using/skills",{"_59":496},"using/project-agents.mdx","Project agents","Create reusable agent personas, select them for threads, and configure task delegation.","/docs/using/project-agents",{"_59":501},"using/ai-threads.mdx","AI threads","Run agents on your connected machines, steer their work, and share read-only conversations with teammates.","/docs/using/ai-threads",{"_59":506},"using/index.mdx","Projects and tasks","Organize your team, track work in Lists and views, and keep comments, files, and artifacts with each task.","/docs/using",{"_59":511},"_1","","operations/faq.mdx","FAQ","Short answers to common Convoy usage, CLI, and deployment questions.","/docs/operations/faq",{"_59":518},"quickstart-join.mdx","First connection","What you need to connect a local runtime to an existing Convoy project.","/docs/quickstart-join",{"_59":523},"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",{"_59":528},"index.mdx","Introduction","Manage project work and run AI threads on a connected machine.","/docs",{"_59":533},"_0","","Getting started"]

Operations

Pages

On this page