Developer / integrator workflow
If you are building on XRTM, start by understanding the shipped product path first. The canonical run artifacts, report outputs, and local surfaces are the contracts your integrations should respect.
Page role
Developer reference entry. This page helps you choose the right repo and
source of truth. xrtm.org is a repo map, not the canonical API manual.
Quick chooser
| Need | Start here | Canonical owner |
|---|---|---|
| released CLI workflow, artifact contract, WebUI/TUI, profile/monitor flows | xrtm + Getting started | xrtm repo |
| Python APIs that ship with the product shell | xrtm/docs/python-api-reference.md | xrtm repo |
| forecasting runtime APIs, provider integrations, agent examples | xrtm-forecast + forecast docs index | forecast repo |
| schema compatibility, release labeling, graduation policy | xrtm-org/governance | governance repo |
Recommended order
- Complete Getting started
- Read Examples and proof
- Use Packages and architecture to choose the right package boundary
- Drop into the owning repo's examples and APIs only after the product flow is clear
Package map
xrtm: top-level product shell, CLI workflow, artifacts, WebUI, and TUIxrtm-forecast: runtime, providers, orchestration, and agent examplesxrtm-eval: scoring and calibration-oriented evaluation utilitiesxrtm-data: schemas and temporal snapshot foundationsxrtm-train: replay, calibration demos, and evaluation harnesses
Canonical references by layer
| Layer | Repo | Best entry point |
|---|---|---|
| Product shell | xrtm | README.md, docs/getting-started.md, docs/python-api-reference.md |
| Runtime | forecast | README.md, docs/index.md |
| Governance | governance | README.md, policy files under policies/ |
What counts as shipped vs. example
- The CLI path in Getting started is a shipped product workflow.
- The example scripts listed in Examples and proof are shipped source examples.
- The Next release track is the right home for real branch work that should not be presented as released yet.
- The Roadmap is future-facing and should not be treated as a current product claim.