Docs

Reference overview

Catalogs and schemas — CLI commands, config file, env vars, MCP tools, glossary, and roadmap.

This section is the dense reference cluster: catalogs and schemas rather than narrative.

  • CLI command reference — every convoy command and flag in one place.
  • Config file (config.toml) — full schema for ~/.config/convoy/config.toml, including profile resolution order.
  • Environment variables — matrix of every env var and where it belongs (Convex dashboard vs. web host vs. local .env.local).
  • MCP tools — every tool the Convoy MCP server exposes, with argument tables derived from the server's own tool-definitions module.
  • Glossary — short definitions of terms used throughout the docs and the product.
  • Roadmap — runtime execution status, planned vs. supported integrations.

One reference-style page lives elsewhere by design: Keyboard shortcuts stays with the product docs it describes.

Authoring docs

Edit and extend the Convoy docs site — where content lives, how the sidebar is configured, and what stays in sync with code.

CLI command reference

Every convoy command and flag, derived from the CLI's own command definitions.