◍ Docs
The pages the oam binary itself links to, plus where the
rest of the documentation actually lives.
This is not the whole manual. Most of what you would
look up ships in the repository beside the code that has to stay true
to it. These pages exist because a running binary prints their URLs and
a printed URL has to resolve.
On this site
-
Debugging with the inspector —
--inspectand--inspect-brk: what attaches, what a debugger sees, and where TypeScript stops being TypeScript. -
Diagnostic codes — every
OAM-*code oam emits, what it means, what to do about it. -
ODIF — the JSON Lines envelope behind
--json, field by field.
In the repository
- README — what oam is, what is measured, how it is governed.
-
CLI reference
— every command, the Node compatibility flags oam implements,
and the environment variables
--helpdoes not list. - Node divergences — where oam deliberately does something other than what Node does.
- Conformance scorecard — results against a vendored subset of Node's own test suite, with the denominator stated.
- Changelog — every release, breaking changes called out.
Fastest answer
oam --help and oam <command> --help are
generated from the code and are authoritative for flags. For a
diagnostic code, oam explains it without a network: register the MCP
server (claude mcp add oam -- oam mcp) and its explain tool
answers from a table compiled into the binary.