# neuralSPOT-X

> The single CLI that scaffolds, builds, flashes and profiles firmware for Ambiq SoCs.

## Getting started

- [Getting started](https://ambiqai.github.io/neuralspotx/getting-started/index.md): What NSX does, what your machine needs before you install it, and the order to work through the rest of this section.
- [Check your environment](https://ambiqai.github.io/neuralspotx/getting-started/doctor/index.md): What nsx doctor checks, how to read a passing and a failing report, and when to use its JSON output.
- [Create your first app](https://ambiqai.github.io/neuralspotx/getting-started/first-app/index.md): Scaffold an NSX app for an Apollo510 EVB with nsx create-app, and read what it wrote.
- [Configure and build](https://ambiqai.github.io/neuralspotx/getting-started/configure-and-build/index.md): Resolve the module graph, generate the CMake tree and link a firmware image with nsx configure and nsx build. No board required.
- [Flash, reset and view](https://ambiqai.github.io/neuralspotx/getting-started/flash-and-view/index.md): Find your J-Link probe, program the board with nsx flash, stream SWO output with nsx view, and reset a target explicitly.
- [Next steps](https://ambiqai.github.io/neuralspotx/getting-started/next-steps/index.md): Where to go once your first app builds and runs, across the guides, the module catalog, the examples and the reference.
- [Migrating from neuralSPOT](https://ambiqai.github.io/neuralspotx/getting-started/migrate-from-neuralspot/index.md): How legacy neuralSPOT packages map onto NSX modules, what has moved, what was split, and what has no equivalent yet.

## Getting started / Install

- [Install](https://ambiqai.github.io/neuralspotx/getting-started/install/index.md): Install the host tools, the Arm GNU toolchain, the SEGGER J-Link pack and the nsx CLI on macOS, Linux or Windows.
- [Install on macOS](https://ambiqai.github.io/neuralspotx/getting-started/install/macos/index.md): The macOS column of the install steps, plus the optional armclang and ATfE toolchain setup for macOS.
- [Install on Linux](https://ambiqai.github.io/neuralspotx/getting-started/install/linux/index.md): The Linux column of the install steps, plus the optional armclang and ATfE toolchain setup for Linux.
- [Install on Windows](https://ambiqai.github.io/neuralspotx/getting-started/install/windows/index.md): The Windows column of the install steps, plus the optional armclang and ATfE toolchain setup for Windows.

## Guides

- [Guides](https://ambiqai.github.io/neuralspotx/guides/index.md): Task guides for building apps with NSX, covering apps, modules, memory, startup, toolchains, the concepts behind app generation, the Python API and the example apps.
- [Python API guide](https://ambiqai.github.io/neuralspotx/guides/python-api/index.md): Drive NSX from Python instead of the shell, handle its results and errors, and give an agent a machine-readable view of the CLI.

## Guides / Apps

- [The app model](https://ambiqai.github.io/neuralspotx/guides/apps/app-model/index.md): What an NSX app is, why it vendors its own modules and boards, and the choices nsx create-app asks you to make.
- [App layout](https://ambiqai.github.io/neuralspotx/guides/apps/app-layout/index.md): Every file and directory in a generated NSX app, when each one appears, and which ones you edit.
- [Build, flash and view](https://ambiqai.github.io/neuralspotx/guides/apps/build-flash-view/index.md): How nsx configure, build, flash, reset and view behave day to day, including the reset policy and the flags worth knowing.
- [Boards and targets](https://ambiqai.github.io/neuralspotx/guides/apps/boards-and-targets/index.md): How an NSX app declares the boards it targets, what a board definition provides, and how to build one app for several of them.
- [Troubleshooting](https://ambiqai.github.io/neuralspotx/guides/apps/troubleshooting/index.md): The errors NSX actually prints, what each one means, and the fix, from app discovery through module resolution to flashing and SWO.

## Guides / Modules in your app

- [Using modules](https://ambiqai.github.io/neuralspotx/guides/modules/using-modules/index.md): Find, add, inspect and remove the modules an NSX app depends on, and understand what the board baseline already gives you.
- [Custom modules](https://ambiqai.github.io/neuralspotx/guides/modules/custom-modules/index.md): Scaffold a module of your own, wire its CMake surface, validate its manifest, and point an app at it from a path, a fork or your own repository.
- [Lock and sync](https://ambiqai.github.io/neuralspotx/guides/modules/lock-and-sync/index.md): How nsx lock resolves and pins the module graph, how nsx sync materializes it, how to pin a module to an exact revision, and the flags that make a build reproducible in CI.
- [SDK providers](https://ambiqai.github.io/neuralspotx/guides/modules/sdk-providers/index.md): How an NSX app gets its AmbiqSuite payload, which modules wrap it, and how to build against an SDK tree of your own.

## Guides / System

- [System initialization](https://ambiqai.github.io/neuralspotx/guides/system/system-init/index.md): The two initialization layers a generated app can call, what each one configures, and how to turn on SWO or UART output.
- [Memory placement](https://ambiqai.github.io/neuralspotx/guides/system/memory-placement/index.md): Put code and data in the memory region you meant, using the NSX_MEM macros, and manage the caches that decide whether it matters.
- [Startup and linker](https://ambiqai.github.io/neuralspotx/guides/system/startup-and-linker/index.md): Which startup file and linker script your board selects, where they come from, and how to override the selection.
- [Toolchain support](https://ambiqai.github.io/neuralspotx/guides/system/toolchains/index.md): The three cross compilers NSX generates for, how one is selected, what differs between them, and which is experimental.

## Guides / Concepts

- [Concepts](https://ambiqai.github.io/neuralspotx/guides/concepts/index.md): The five ideas behind how NSX generates an app, resolves its dependencies and keeps one source tree building for several boards.
- [App generation flow](https://ambiqai.github.io/neuralspotx/guides/concepts/app-generation-flow/index.md): What nsx create-app and nsx configure actually do, in order, and which files exist after each stage.
- [Dependency model](https://ambiqai.github.io/neuralspotx/guides/concepts/dependency-model/index.md): How NSX turns the modules you declare into the set it actually builds, what the board baseline contributes, and why the closure lives only in the lock.
- [Module model](https://ambiqai.github.io/neuralspotx/guides/concepts/module-model/index.md): What a module is in NSX terms, the eight module types, how a module contributes CMake targets, and what makes one portable.
- [Metadata model](https://ambiqai.github.io/neuralspotx/guides/concepts/metadata-model/index.md): The four schemas NSX reads and writes, who owns each one, and how they fit together.
- [Multi-target and portability](https://ambiqai.github.io/neuralspotx/guides/concepts/multi-target/index.md): How one app source tree builds for several boards, what stays shared, and how to handle the parts that genuinely have to differ.

## Guides / Examples

- [Examples](https://ambiqai.github.io/neuralspotx/guides/examples/index.md): The example apps this repository ships, what each one demonstrates, and the tier, status and boards their authors declare.
- [FreeRTOS Blinky](https://ambiqai.github.io/neuralspotx/guides/examples/freertos_blinky/index.md): FreeRTOS task blinking an LED with periodic tick logging over SWO.
- [Hello World](https://ambiqai.github.io/neuralspotx/guides/examples/hello_world/index.md): Minimal SWO printf loop to verify your toolchain, board connection, and viewer.
- [USB Serial](https://ambiqai.github.io/neuralspotx/guides/examples/usb_serial/index.md): USB CDC virtual COM port that echoes received data back to the host.
- [Audio Capture](https://ambiqai.github.io/neuralspotx/guides/examples/audio_capture/index.md): PDM microphone capture with RMS/peak statistics streamed over SWO.
- [CoreMark](https://ambiqai.github.io/neuralspotx/guides/examples/coremark/index.md): EEMBC CoreMark with ITCM execution; score is emitted over SEGGER RTT.
- [PMU Profiling](https://ambiqai.github.io/neuralspotx/guides/examples/pmu_profiling/index.md): Cortex-M55 PMU cycle counting, cache hits, and branch mispredicts.
- [Power Benchmark](https://ambiqai.github.io/neuralspotx/guides/examples/power_benchmark/index.md): Three-phase power measurement across CoreMark, idle, and deep sleep.
- [BLE Webble](https://ambiqai.github.io/neuralspotx/guides/examples/ble_webble/index.md): Minimal Bluetooth LE peripheral with app-owned Cordio/WSF policy.
- [KWS Inference](https://ambiqai.github.io/neuralspotx/guides/examples/kws_infer/index.md): TFLite Micro keyword-spotting inference with CMSIS-NN kernels.
- [USB RPC](https://ambiqai.github.io/neuralspotx/guides/examples/usb_rpc/index.md): USB vendor-class RPC with nanopb protobuf serialization.

## Guides / Contribute

- [Agent guidance](https://ambiqai.github.io/neuralspotx/guides/contribute/agent-guidance/index.md): What an agent working in an NSX app should rely on, which surfaces are machine readable, and the invariants not to break.
- [Adding a board](https://ambiqai.github.io/neuralspotx/guides/contribute/adding-a-board/index.md): Scaffold a board definition, fill in its five CMake fragments and its descriptor, and get an app building against hardware NSX does not package.
- [Adding a module](https://ambiqai.github.io/neuralspotx/guides/contribute/adding-a-module/index.md): Take a module from a scaffold to something other apps can depend on, including the metadata that makes it findable and the rules NSX enforces.

## Modules

- [Modules](https://ambiqai.github.io/neuralspotx/modules/index.md): Every module the neuralSPOT-X registry pins, what it provides, and which boards, SoCs and toolchains its manifest declares.
- [Module catalog](https://ambiqai.github.io/neuralspotx/modules/catalog/index.md): All 50 modules the neuralSPOT-X registry pins, filterable by type, SoC, board, toolchain and capability.
- [Board matrix](https://ambiqai.github.io/neuralspotx/modules/boards/index.md): The 17 board descriptors neuralSPOT-X ships, with the SoC, tier, SDK provider, CPU and toolchains each one declares.

## Modules / SDK providers

- [nsx-ambiqsuite](https://ambiqai.github.io/neuralspotx/modules/nsx-ambiqsuite/index.md): Unified AmbiqSuite SDK provider covering all staged Apollo NSX targets.

## Modules / SoC support

- [nsx-soc-hal](https://ambiqai.github.io/neuralspotx/modules/nsx-soc-hal/index.md): Shared SoC-level HAL integration layer for NSX targets.

## Modules / Board support

- [nsx-board-apollo2-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo2-evb/index.md): What the nsx-board-apollo2-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo3-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo3-evb/index.md): What the nsx-board-apollo3-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo3-evb-cygnus](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo3-evb-cygnus/index.md): What the nsx-board-apollo3-evb-cygnus module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo330mp-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo330mp-evb/index.md): What the nsx-board-apollo330mp-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo3p-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo3p-evb/index.md): What the nsx-board-apollo3p-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo3p-evb-cygnus](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo3p-evb-cygnus/index.md): What the nsx-board-apollo3p-evb-cygnus module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4l-blue-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4l-blue-evb/index.md): What the nsx-board-apollo4l-blue-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4l-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4l-evb/index.md): What the nsx-board-apollo4l-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4p-blue-kbr-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4p-blue-kbr-evb/index.md): What the nsx-board-apollo4p-blue-kbr-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4p-blue-kxr-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4p-blue-kxr-evb/index.md): What the nsx-board-apollo4p-blue-kxr-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4p-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4p-evb/index.md): What the nsx-board-apollo4p-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo4p-evb-disp-shield-rev2](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo4p-evb-disp-shield-rev2/index.md): What the nsx-board-apollo4p-evb-disp-shield-rev2 module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo510-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo510-evb/index.md): What the nsx-board-apollo510-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo510b-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo510b-evb/index.md): What the nsx-board-apollo510b-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo510dl-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo510dl-evb/index.md): What the nsx-board-apollo510dl-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-apollo5b-evb](https://ambiqai.github.io/neuralspotx/modules/nsx-board-apollo5b-evb/index.md): What the nsx-board-apollo5b-evb module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.
- [nsx-board-atomiq110-fpga-turbo](https://ambiqai.github.io/neuralspotx/modules/nsx-board-atomiq110-fpga-turbo/index.md): What the nsx-board-atomiq110-fpga-turbo module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.

## Modules / Runtimes

- [helia-dsp](https://ambiqai.github.io/neuralspotx/modules/helia-dsp/index.md): NSX-packaged helia-dsp fork of CMSIS-DSP, preserving upstream Source/ CMake as the single source of truth.
- [nsx-core](https://ambiqai.github.io/neuralspotx/modules/nsx-core/index.md): Core runtime initialization, universal helpers, and byte ring-buffer support.
- [nsx-ethos-u-driver](https://ambiqai.github.io/neuralspotx/modules/nsx-ethos-u-driver/index.md): NSX integration of Arm's Ethos-U core driver. Wraps the upstream ethos-u-core-driver (vendored as plain files) with NSX build glue, CMSIS-based cache coherency 
- [nsx-nanopb](https://ambiqai.github.io/neuralspotx/modules/nsx-nanopb/index.md): Vendored nanopb v0.4.9.1 — a small, zero-dynamic-memory Protocol Buffers implementation in ANSI C. Provides pb_encode / pb_decode for structured message seriali
- [nsx-perf](https://ambiqai.github.io/neuralspotx/modules/nsx-perf/index.md): Generic performance measurement helpers for timing and lightweight profiling.
- [nsx-physiokit](https://ambiqai.github.io/neuralspotx/modules/nsx-physiokit/index.md): Physiologic signal-processing primitives for ECG, PPG, respiration, IMU, and HRV workflows.
- [nsx-pmu-armv8m](https://ambiqai.github.io/neuralspotx/modules/nsx-pmu-armv8m/index.md): Armv8-M PMU helpers for hardware counter configuration, capture, and transport.
- [nsx-sensors](https://ambiqai.github.io/neuralspotx/modules/nsx-sensors/index.md): Reusable external sensor and accessory drivers built on NSX transport modules.
- [nsx-tflite-micro](https://ambiqai.github.io/neuralspotx/modules/nsx-tflite-micro/index.md): Thin NSX wrapper for the helia-rt TensorFlow Lite Micro runtime using reference kernels or standard Arm CMSIS-NN kernels.

## Modules / Algorithms

- [nsx-cmsis-nn](https://ambiqai.github.io/neuralspotx/modules/nsx-cmsis-nn/index.md): Ambiq-optimized CMSIS-NN neural network kernels. Fork of ARM CMSIS-NN with MVE and DSP optimizations for Apollo SoCs.
- [nsx-helia-rt](https://ambiqai.github.io/neuralspotx/modules/nsx-helia-rt/index.md): Ambiq-optimized TensorFlow Lite for Microcontrollers (TFLM) runtime. Built from source against the nsx-cmsis-nn (ns-cmsis-nn) kernel module.

## Modules / Tooling

- [helia-rt-source](https://ambiqai.github.io/neuralspotx/modules/helia-rt-source/index.md): Source-provider module for consumers that compile the helia-rt TFLM source tree with their own NSX runtime wrapper.
- [nsx-tooling](https://ambiqai.github.io/neuralspotx/modules/nsx-tooling/index.md): What the nsx-tooling module declares: type, dependencies and the boards, SoCs and toolchains in its manifest.

## Modules / Backend specific

- [arm-cmsis-nn](https://ambiqai.github.io/neuralspotx/modules/arm-cmsis-nn/index.md): Thin NSX wrapper around Arm's upstream CMSIS-NN implementation. It exposes the standard cmsis-nn library as nsx::arm_cmsis_nn for TFLM consumers.
- [nsx-ambiq-bsp](https://ambiqai.github.io/neuralspotx/modules/nsx-ambiq-bsp/index.md): Curated BSP wrapper surface for board-support integration on AmbiqSuite targets (all SoCs).
- [nsx-ambiq-hal](https://ambiqai.github.io/neuralspotx/modules/nsx-ambiq-hal/index.md): Curated Ambiq HAL wrapper surface for AmbiqSuite targets (all SoCs).
- [nsx-ambiq-usb](https://ambiqai.github.io/neuralspotx/modules/nsx-ambiq-usb/index.md): Unified AmbiqSuite USB substrate (TinyUSB) for Apollo4P and Apollo5 SoCs.
- [nsx-audio](https://ambiqai.github.io/neuralspotx/modules/nsx-audio/index.md): PDM audio capture helper for AmbiqSuite-backed NSX targets with staged PDM support.
- [nsx-ble](https://ambiqai.github.io/neuralspotx/modules/nsx-ble/index.md): Optional app-facing Bluetooth LE convenience API. Ports the legacy neuralSPOT ns-ble wrapper onto NSX, providing simple "define a service + read/write/notify ch
- [nsx-cmsis-core](https://ambiqai.github.io/neuralspotx/modules/nsx-cmsis-core/index.md): Standalone CMSIS-Core(M) header package (ARM CMSIS_6 v6.2.0), decoupled from AmbiqSuite SDK vendoring.
- [nsx-cmsis-startup](https://ambiqai.github.io/neuralspotx/modules/nsx-cmsis-startup/index.md): CMSIS and startup integration for vector tables, startup code, and early boot wiring.
- [nsx-cordio](https://ambiqai.github.io/neuralspotx/modules/nsx-cordio/index.md): Optional Cordio/WSF Bluetooth LE host stack. Vendors the AmbiqSuite third_party Cordio stack (ble-host + ble-profiles + WSF) pinned to the provider SDK drop and
- [nsx-freertos](https://ambiqai.github.io/neuralspotx/modules/nsx-freertos/index.md): Optional FreeRTOS kernel middleware. Vendors a pinned upstream FreeRTOS-Kernel and builds the SoC-selected CMSIS port. Kernel/heap policy and FreeRTOSConfig.h a
- [nsx-i2c](https://ambiqai.github.io/neuralspotx/modules/nsx-i2c/index.md): I2C bus API contract and register-access helpers for AmbiqSuite-backed NSX targets.
- [nsx-npu](https://ambiqai.github.io/neuralspotx/modules/nsx-npu/index.md): Atomiq110 glue for the Arm Ethos-U85 NPU: power-domain sequencing, IRQ wiring, and performance-mode selection on top of the pristine upstream driver (nsx-ethos-
- [nsx-power](https://ambiqai.github.io/neuralspotx/modules/nsx-power/index.md): AmbiqSuite power-management helpers for sleep policy, shutdown control, and low-power workflows across supported Apollo3, Apollo4, and Apollo5 targets.
- [nsx-spi](https://ambiqai.github.io/neuralspotx/modules/nsx-spi/index.md): SPI wrapper helpers for talking to SPI-attached devices and peripherals.
- [nsx-tileio-ble](https://ambiqai.github.io/neuralspotx/modules/nsx-tileio-ble/index.md): Tileio BLE transport wrapper on top of nsx-ble.
- [nsx-tileio-usb](https://ambiqai.github.io/neuralspotx/modules/nsx-tileio-usb/index.md): Tileio USB transport wrapper on top of nsx-usb.
- [nsx-uart](https://ambiqai.github.io/neuralspotx/modules/nsx-uart/index.md): UART wrapper helpers for serial communication, console I/O, and simple host-device links.
- [nsx-usb](https://ambiqai.github.io/neuralspotx/modules/nsx-usb/index.md): USB CDC serial driver for Ambiq SoCs using the SDK-hosted TinyUSB substrate.

## Reference

- [Reference](https://ambiqai.github.io/neuralspotx/reference/index.md): Every NSX command and option, the public Python API, and the schema of each manifest NSX reads.
- [Releases and versioning](https://ambiqai.github.io/neuralspotx/reference/releases/index.md): How NSX versions are numbered and tagged, what the Provisional stability tier means, and how to pin a version you depend on.

## Reference / CLI

- [CLI reference](https://ambiqai.github.io/neuralspotx/reference/cli/index.md): Every nsx command and subcommand, with its options, defaults and usage, generated from the parser.
- [nsx build](https://ambiqai.github.io/neuralspotx/reference/cli/build/index.md): Build a generated NSX app
- [nsx clean](https://ambiqai.github.io/neuralspotx/reference/cli/clean/index.md): Clean a generated NSX app build directory
- [nsx commands](https://ambiqai.github.io/neuralspotx/reference/cli/commands/index.md): Show the NSX command graph for users and agents
- [nsx configure](https://ambiqai.github.io/neuralspotx/reference/cli/configure/index.md): Configure a generated NSX app with CMake
- [nsx create-app](https://ambiqai.github.io/neuralspotx/reference/cli/create-app/index.md): Create a new standalone NSX app project
- [nsx doctor](https://ambiqai.github.io/neuralspotx/reference/cli/doctor/index.md): Check the local NSX toolchain environment
- [nsx flash](https://ambiqai.github.io/neuralspotx/reference/cli/flash/index.md): Build and flash a generated NSX app
- [nsx lock](https://ambiqai.github.io/neuralspotx/reference/cli/lock/index.md): Resolve modules in nsx.yml to commits and write nsx.lock
- [nsx outdated](https://ambiqai.github.io/neuralspotx/reference/cli/outdated/index.md): Show git modules whose locked commit lags behind upstream
- [nsx probes](https://ambiqai.github.io/neuralspotx/reference/cli/probes/index.md): List connected SEGGER J-Link debug probes
- [nsx reset](https://ambiqai.github.io/neuralspotx/reference/cli/reset/index.md): Explicitly reset a target with SEGGER J-Link
- [nsx sbom](https://ambiqai.github.io/neuralspotx/reference/cli/sbom/index.md): Generate a Software Bill of Materials from nsx.lock
- [nsx sync](https://ambiqai.github.io/neuralspotx/reference/cli/sync/index.md): Make modules/ exactly match nsx.lock
- [nsx update](https://ambiqai.github.io/neuralspotx/reference/cli/update/index.md): Re-resolve constraints to upstream tip and sync modules
- [nsx view](https://ambiqai.github.io/neuralspotx/reference/cli/view/index.md): Open the SEGGER SWO viewer for a generated NSX app

## Reference / CLI / nsx board

- [nsx board](https://ambiqai.github.io/neuralspotx/reference/cli/board/index.md): Inspect packaged boards and scaffold custom boards
- [nsx board create](https://ambiqai.github.io/neuralspotx/reference/cli/board-create/index.md): Scaffold a custom board that inherits an EVB
- [nsx board list](https://ambiqai.github.io/neuralspotx/reference/cli/board-list/index.md): List available boards
- [nsx board show](https://ambiqai.github.io/neuralspotx/reference/cli/board-show/index.md): Show details for a single board

## Reference / CLI / nsx cache

- [nsx cache](https://ambiqai.github.io/neuralspotx/reference/cli/cache/index.md): Inspect or clean neuralSPOT-X on-disk caches
- [nsx cache clean](https://ambiqai.github.io/neuralspotx/reference/cli/cache-clean/index.md): Remove every neuralSPOT-X cache
- [nsx cache info](https://ambiqai.github.io/neuralspotx/reference/cli/cache-info/index.md): Show cache location, entry count, and total size

## Reference / CLI / nsx module

- [nsx module](https://ambiqai.github.io/neuralspotx/reference/cli/module/index.md): Manage app-local NSX modules
- [nsx module add](https://ambiqai.github.io/neuralspotx/reference/cli/module-add/index.md): Add a direct dependency to an app
- [nsx module describe](https://ambiqai.github.io/neuralspotx/reference/cli/module-describe/index.md): Show detailed metadata for one module
- [nsx module init](https://ambiqai.github.io/neuralspotx/reference/cli/module-init/index.md): Create a standard custom-module skeleton
- [nsx module list](https://ambiqai.github.io/neuralspotx/reference/cli/module-list/index.md): List modules from the packaged or app-effective registry
- [nsx module register](https://ambiqai.github.io/neuralspotx/reference/cli/module-register/index.md): Register and vendor an external module for one app
- [nsx module remove](https://ambiqai.github.io/neuralspotx/reference/cli/module-remove/index.md): Disable a module for an app
- [nsx module search](https://ambiqai.github.io/neuralspotx/reference/cli/module-search/index.md): Search modules by intent, capability, or keyword
- [nsx module update](https://ambiqai.github.io/neuralspotx/reference/cli/module-update/index.md): Refresh enabled modules to current registry revisions
- [nsx module validate](https://ambiqai.github.io/neuralspotx/reference/cli/module-validate/index.md): Validate an nsx-module.yaml file

## Reference / CLI / Aliases

- [nsx add](https://ambiqai.github.io/neuralspotx/reference/cli/add/index.md): Alias for `nsx module add`
- [nsx list-modules](https://ambiqai.github.io/neuralspotx/reference/cli/list-modules/index.md): Alias for `nsx module list`
- [nsx new](https://ambiqai.github.io/neuralspotx/reference/cli/new/index.md): Alias for create-app

## Reference / Python API

- [Python API reference](https://ambiqai.github.io/neuralspotx/reference/api/index.md): Every name exported from neuralspotx, generated from the installed package.

## Reference / Python API / By module

- [neuralspotx](https://ambiqai.github.io/neuralspotx/reference/api/neuralspotx/index.md): Canonical Python package for neuralspotx tooling.
- [neuralspotx.api](https://ambiqai.github.io/neuralspotx/reference/api/neuralspotx/api/index.md): Programmatic API for the NSX workflow.
- [neuralspotx.models](https://ambiqai.github.io/neuralspotx/reference/api/neuralspotx/models/index.md): Typed internal models for NSX registry, manifest, and app metadata.
- [neuralspotx.nsx_lock](https://ambiqai.github.io/neuralspotx/reference/api/neuralspotx/nsx_lock/index.md): nsx.lock — resolution receipt for an NSX app.
- [neuralspotx.operations](https://ambiqai.github.io/neuralspotx/reference/api/neuralspotx/operations/index.md): Shared NSX workflow operations for CLI and programmatic use.

## Reference / Configuration

- [Configuration reference](https://ambiqai.github.io/neuralspotx/reference/config/index.md): The schema of every file NSX reads: the app manifest, module metadata, board descriptors and the resolution lock.
- [nsx.yml](https://ambiqai.github.io/neuralspotx/reference/config/nsx-yml/index.md): The app manifest. Names the app, the boards it supports, the toolchain and the modules it depends on directly.
- [nsx-module.yaml](https://ambiqai.github.io/neuralspotx/reference/config/nsx-module-yaml/index.md): Module metadata. Declares what a module is, what it builds, what it needs and what it is compatible with.
- [board.yaml](https://ambiqai.github.io/neuralspotx/reference/config/board-yaml/index.md): Board descriptor. Describes the SoC, the CPU ABI and the toolchains a board can be built with. A board may inherit from another and apply deltas.
- [nsx.lock](https://ambiqai.github.io/neuralspotx/reference/config/nsx-lock/index.md): The resolution lock. Records, per board, the exact commit and content hash of every module an nsx sync would materialize. NSX writes it; you do not edit it by hand.

## Other pages

- [The modular firmware platform for Ambiq SoCs.](https://ambiqai.github.io/neuralspotx/index.md): The modular developer SDK and CLI for bare-metal Ambiq applications, from scaffolding an app for a board to flashing it and reading its output.

## Machine-readable

- [llms-full.txt](https://ambiqai.github.io/neuralspotx/llms-full.txt): every page above as Markdown, in sidebar order
- [modules/catalog.json](https://ambiqai.github.io/neuralspotx/modules/catalog.json): the module catalog: one record per module
- [modules/boards.json](https://ambiqai.github.io/neuralspotx/modules/boards.json): the board matrix
- [reference/api/reference.json](https://ambiqai.github.io/neuralspotx/reference/api/reference.json): the Python API model
- [reference/api/llms-full.txt](https://ambiqai.github.io/neuralspotx/reference/api/llms-full.txt): the Python API as Markdown
- [reference/reference.txt](https://ambiqai.github.io/neuralspotx/reference/reference.txt): the whole reference as text
- [reference/cli.json](https://ambiqai.github.io/neuralspotx/reference/cli.json): every command, subcommand and option
- [reference/config.json](https://ambiqai.github.io/neuralspotx/reference/config.json): the 4 configuration schemas
- [reference/python-symbols.json](https://ambiqai.github.io/neuralspotx/reference/python-symbols.json): every public Python name
- [content-index.json](https://ambiqai.github.io/neuralspotx/content-index.json): every route with its title and headings
- [build-info.json](https://ambiqai.github.io/neuralspotx/build-info.json): the package version and the source commit