nsx build¶

Builds a generated NSX app.

Syntax¶

nsx build [--app-dir APP_DIR] [--board BOARD]
          [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN]
          [--sdk-root SDK_ROOT] [--target TARGET] [--jobs JOBS]
          [--update] [--frozen] [--timeout SECONDS] [app]

Main Arguments¶

• --app-dir: app directory containing nsx.yml; when omitted, NSX searches upward from the current directory
• app: optional app name or directory; overrides --app-dir and is resolved under the current directory and examples/
• --board: select a board from the app's supported targets instead of targets.default
• --build-dir: build directory override
• --toolchain: toolchain override (gcc, armclang, atfe). Defaults to nsx.yml → arm-none-eabi-gcc
• --sdk-root: escape hatch — build against an out-of-tree AmbiqSuite root (NSX_AMBIQSUITE_ROOT_OVERRIDE); warns that nsx.lock/SBOM no longer describe the binary, cannot be combined with --frozen, and forces a reconfigure when it differs from the cached override. See SDK provider selection
• --target: explicit build target
• --jobs: parallel build jobs
• --update: re-resolve module constraints to upstream tips and re-vendor before building
• --frozen: when configure is needed, reject manifest, lock, or vendored-module drift
• --timeout: wall-clock budget per subprocess; a timeout terminates the process group

Example¶

cd <app-dir>
nsx build --jobs 8

Notes¶

• this operates on the generated app’s CMake build tree
• run nsx commands --json for the authoritative machine-readable argument schema