nxp_monkey is a public CLI and Python library that wraps NXP's
MCUXpresso Config Tools KEX storage API. This directory holds the
machine-readable design documentation required for release signoff
(see ADR-0005).
Every public CLI command has a doc under cli/ with a
data-command attribute. Every public Python interface has a
doc under api/ with a data-interface attribute.
L99_signoff verifies these are present and synchronized with
docs/contracts/.
| Command | Design doc | Summary |
|---|---|---|
| versions | cli/versions.html | List MCUXpresso tool versions |
| families | cli/families.html | List processor families |
| search | cli/search.html | Search the local index |
| index | cli/index.html | Build / inspect the local index |
| fetch | cli/fetch.html | Fetch parts into the local cache (XML + JSON output) |
| details | cli/details.html | Print the parsed chip-data spine for one part |
| roadmap | cli/roadmap.html | Print the per-part agent roadmap (layout + schema) |
| cache | cli/cache.html | Inspect / manage the cache |
| help | cli/help.html | Help alias |
| Module | Design doc | Symbols |
|---|---|---|
| nxp_monkey.models | api/models.html | ApiVersion, StorageEntry, PartInfo, SearchHit, IndexMeta |
| nxp_monkey.kex_client | api/kex_client.html | KexClient, NxpFetchError, list_versions, latest_version, list_families, portfolio_latest_map |
| nxp_monkey.fetch | api/fetch.html | fetch, fetch_all |
| nxp_monkey.details | api/details.html | details |
| nxp_monkey.roadmap | api/roadmap.html | build_roadmap |
| nxp_monkey.search | api/search.html | search, part_variants |
| nxp_monkey.index | api/index.html | build_index, get_part, open_index, index_meta |
| nxp_monkey.cache | api/cache.html | cache_path, cache_size, cache_clear |
| nxp_monkey.xml_json | api/xml_json.html | xml_file_to_dict, mirror_xml_tree_as_json |