Skip to content

Reference

Complete and accurate reference documentation for every Canopy interface. Reference pages are generated from the source and kept in sync with each release.

In This Section

Section titled “In This Section”
  • CLI Reference — Every canopy subcommand with all flags, arguments, defaults, examples, and exit codes.
  • MCP Tools Reference — All 21 tools grouped by category, with input parameters, output format, tier requirements, and usage examples.
  • Configuration — Every option in config.toml and team.yml, with types, defaults, precedence rules, and examples.
  • Environment Variables — Every environment variable Canopy reads, with descriptions and usage examples.
  • License File Format — Schema of ~/.canopy/license.json, field descriptions, feature flags, and backward-compatibility notes.
  • Heartbeat Protocol — Exact payload, frequency, cache semantics, transparency commands, and air-gapped behavior.
  • Plugin API — Write custom health check plugins using the Canopy YAML schema and ast-grep patterns.
  • Error Codes — Every Canopy error code with description, likely cause, and fix.

For the Getting Started experience and conceptual overview, see Getting Started and Concepts.