nxp-monkey roadmap

design / cli / roadmap

Purpose

Emit a per-part roadmap pointing an agent at where things live in the unpacked KEX tree, plus the distinct XML namespaces observed (the inferred schema, since NXP publishes no XSDs). Mirrors the narrative in docs/research/xml_survey.md, but is generated from the on-disk tree so it reflects the part at hand.

Usage

nxp-monkey roadmap PART [--variant VARIANT] [--version VERSION]

Behavior

Fetches PART on demand if the local cache is empty for the requested SDK variant. Defaults to ksdk2_0 per ADR-0008. Resolves the tool version per ADR-0007 unless --version is explicit.

Output

Text mode prints a short ordered guide, the key_files map, which optional top-level sections are present (security/, dcdx/, ddr/, mem_validation/), per-package variants, codegen entry points (including Zephyr DT scripts), and every distinct xmlns URI observed in the tree.

JSON mode (--json) writes <PART>.roadmap.json in the working directory and prints the path on stdout. The same payload is also always written by nxp-monkey fetch alongside the mirrored tree at <output>/<PART>/json/<PART>.roadmap.json (independent of the global --json flag).

Library equivalent

nxp_monkey.build_roadmap(part_root)

Tests

Related