Tracking plan and codegen
The Catalog records what every event means; the CLI turns it into typed wrappers.
The Catalog is your tracking plan. Each event has a status, the question it answers, and typed
properties, including money (money_minor) and a personal-data level.
| Status | Meaning |
|---|---|
planned | Agreed, not seen yet. |
implemented | Seen in the data. The background sync flips planned events once they arrive. |
verified | Someone checked the data is right. |
deprecated | Still arriving, on its way out. |
unplanned | Arriving, but nobody planned it. |
Catalog → Live streams events as they arrive, which is the fastest way to check an integration.
Typed wrappers with atrix codegen
The atrix CLI generates typed tracking functions from the plan, so a typo in an event or property name is a
compile error instead of a silent gap in a chart.
export ATRIX_TOKEN=atx_pat_… # a token with the catalog:read scope
export ATRIX_API_URL=https://app.analytics.atrix.dev
atrix codegen --project <project-uuid> --lang ts --out src/atrix-events.ts| Flag | |
|---|---|
--project | The project's UUID. |
--lang | ts, swift, kotlin, python or go. |
--out | Write to a file instead of stdout. |
--package | Package name for Kotlin and Go. |
--from-file | Generate from a saved catalog/codegen export instead of calling the API. |
--api-url | The control-plane URL (or ATRIX_API_URL). |
Set ATRIX_API_URL=https://app.analytics.atrix.dev (or pass --api-url): the CLI's built-in default points
at a host that is not served. A browser sign-in (atrix login) is planned; until then the CLI reads
ATRIX_TOKEN.
The plan itself is available to any tool at GET /v1/projects/{project_id}/catalog/codegen with a
catalog:read token.