nxp-monkey index

design / cli / index

Purpose

Build and inspect the local SQLite + FTS5 search index. The index is the backing store for nxp-monkey search and for agent / LLM workflows that need a single fast queryable view of "what parts are available."

Usage

nxp-monkey index build [--variant VARIANT] [--probe-variants]
nxp-monkey index show PART
nxp-monkey index info

Actions

ActionEffect
buildPopulate or refresh the index from the KEX portfolio-latest view.
show PARTPrint the recorded info for one part.
infoPrint build metadata (built_at, source_version, counts).

Storage

SQLite database at cache_path() / "index" / "nxp_monkey_index.sqlite" plus a JSON sidecar at nxp_monkey_index.meta.json. See ADR-0006.

--json mode

With the global --json flag, index writes index.json to the working directory (action result: meta for info, the part record for show, build counts for build) and prints that path on stdout.

Library equivalent

nxp_monkey.build_index()
nxp_monkey.get_part("MCXA156")
nxp_monkey.index_meta()

Tests