Getting started

Introduction How Convoy works Quickstart: join a deployment Quickstart: run from source

Deploy Convoy

Deploy Convoy Deploy the Convex Backend Auth and Clerk Deploy to Vercel Email and Resend Deploy the Docs Site Production Checklist Self-hosting Convex

Using Convoy

Using Convoy Organizations, projects, and members Tasks Comments, attachments, and artifacts AI threads Keyboard shortcuts

CLI & AI integrations

CLI & AI integrations overview API keys Install the CLI Setup and connect Profiles, paths, and status Model provider keys

Skills One-shot commands Security model Isolation options

CLI troubleshooting

Operations

Operations Running the CLI long-term Scaling and limits Monitoring and logs Migrations Backups and rollback Upgrading Debugging FAQ

Contributing

Contributing overview Testing Specs-First Workflow CLI architecture and lifecycle Adding a runtime Authoring docs

Reference

Reference overview CLI command reference Config file (config.toml)Environment Variables MCP tools Glossary Roadmap

API keys

Create and manage the keys that authenticate the CLI and MCP integrations.

API keys authenticate a user for CLI and MCP access. Create them in the web app under user settings.

These are different from model provider keys, which stay on the CLI machine and authenticate Claude Code with Bedrock or Mantle.

What API keys are used for

convoy setup and convoy connect
one-shot CLI commands
MCP connections from editors and agents (the generated MCP config embeds the key — see Set up MCP)

Important properties

keys are user-scoped — they act on behalf of the user who created them
keys inherit exactly the permissions that user already has
keys do not create a new permission model or grant anything extra

Operational guidance

create separate keys for separate machines or workflows when possible
rotate keys if a machine is lost or a secret leaks
never commit keys into a repository — this includes generated config files that embed them
prefer config files and local secret storage over shell history

The CLI stores keys in ~/.config/convoy/config.toml (created with mode 0700). See Config file (config.toml).

Related pages

Setup and connect — where the key is first used
Model provider keys — Bedrock and Mantle credentials used by Claude Code
Security model — the full trust model

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.

Install the CLI

Install the Convoy CLI from npm, or run it from a checkout.

On this page

What API keys are used for Important properties Operational guidance Related pages