# Qumo Deploy

- [Overview](https://docs.qumo-deploy.com/guides/overview.md): Welcome to Qumo Deploy — Control plane and edge orchestration for global data relaying.
- [Scopes & Permissions](https://docs.qumo-deploy.com/guides/scopes-permissions.md): Canonical reference for API key scopes and IAM permissions in Qumo Deploy.
- [Error Codes](https://docs.qumo-deploy.com/guides/error-codes.md): Canonical reference for HTTP error codes returned by Qumo Deploy APIs.
- [Local Relay Network](https://docs.qumo-deploy.com/guides/local-relay-network.md): Run the full relay network locally — control plane, peer-discovery, Nomad, Consul, and a relay node.
- [Web Console Overview](https://docs.qumo-deploy.com/console/overview.md): Manage projects, deployments, monitoring, and billing in the Qumo Console.
- [Pricing & Plans](https://docs.qumo-deploy.com/console/billing.md): Review Qumo Deploy plans, included bandwidth quotas, and feature tiers.
- [CLI Overview](https://docs.qumo-deploy.com/cli/overview.md): Control plane command-line interface and automation runtime for Qumo Deploy.
- [Installation](https://docs.qumo-deploy.com/cli/installation.md): Install the standalone qumod CLI binary on macOS, Linux, or Windows.
- [Authentication](https://docs.qumo-deploy.com/cli/authentication.md): Authenticate the qumod CLI via OAuth 2.0 Device Flow or API tokens.
- [Command Reference](https://docs.qumo-deploy.com/cli/commands.md): Detailed syntax, flags, and examples for all qumod commands.
- [CI/CD & Coding Agents](https://docs.qumo-deploy.com/cli/ci-cd.md): Recipes and best practices for integrating qumod into GitHub Actions, GitLab CI, and AI agents.
- [TypeScript SDK Overview](https://docs.qumo-deploy.com/sdk/overview.md): Programmatically orchestrate Qumo Deploy control plane resources with type-safety.
- [Quickstart](https://docs.qumo-deploy.com/sdk/quickstart.md): Get started with @qumo-deploy/sdk in Node.js, Bun, and Deno.
- [Client Reference](https://docs.qumo-deploy.com/sdk/client-reference.md): Core resources, methods, and configurations available in QumoClient.
- [Code Recipes](https://docs.qumo-deploy.com/sdk/recipes.md): Production patterns for project provisioning, credential minting, relay discovery, and budget monitoring.
- [Error Handling & Types](https://docs.qumo-deploy.com/sdk/error-handling.md): Handling APIError, HTTP status codes, and inspecting exported TypeScript types.
- [REST API Overview](https://docs.qumo-deploy.com/api-reference/introduction.md): Interactive API reference, playground, and authentication models for Qumo Deploy.
- [v1.0.0 Release Notes](https://docs.qumo-deploy.com/releases/v1-0-0.md): Initial production release of Qumo Deploy platform and developer tools.
- [Terms of Service](https://docs.qumo-deploy.com/legal/terms.md): Terms and conditions governing the use of Qumo Deploy services.
- [Privacy Policy](https://docs.qumo-deploy.com/legal/privacy.md): Privacy policy and data collection practices for Qumo Deploy.
- [Data Processing Agreement (DPA)](https://docs.qumo-deploy.com/legal/dpa.md): Qumo Deploy Data Processing Agreement template and data handling commitments.
- [Frequently Asked Questions](https://docs.qumo-deploy.com/help/faq.md): Common questions about Qumo Deploy, relays, billing, and connectivity.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)