Skip to content
OrdoOrdo

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

For how to wire the module schema into your editor, see Writing state modules; the same approach applies to the two config schemas above.