Reference

The reference covers the surfaces operators interact with directly. It is generated from the Ordo source (cargo xtask gen-reference) so it stays in step with each release.

• CLI — every command exposed by the ordo, ordo-orchestrator, ordo-agent, and ordo-state binaries.
• Management API — the orchestrator’s HTTP management API, rendered from its OpenAPI document.
• State file format & configuration — machine-readable JSON Schemas are published for editor autocompletion and CI validation:
  • Module files (*.ordo.yaml) — https://getordo.dev/schemas/module/v1.json
  • Orchestrator config (orchestrator.yaml) — https://getordo.dev/schemas/orchestrator-config/v1.json
  • Agent config (agent.yaml) — https://getordo.dev/schemas/agent-config/v1.json

Using the schemas

VS Code (Red Hat YAML extension) — add a modeline to the top of a module file:

# yaml-language-server: $schema=https://getordo.dev/schemas/module/v1.json

or associate the file patterns via the yaml.schemas setting — *.ordo.yaml with the module schema, and orchestrator.yaml / agent.yaml with the matching config schemas.

JetBrains IDEs — map the file pattern to the schema URL under Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings.