{ "aliases": { "add": "module add", "list-modules": "module list", "new": "create-app" }, "commands": [ { "alias_of": "module add", "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Module name to add", "metavar": null, "name": "module", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--local" ], "help": "Mark the module as local (mirrored from external path; ignored by git)", "metavar": null, "name": "--local", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--vendored" ], "help": "Scaffold a vendored module under modules// (committed in this app's git; never touched by `nsx sync`)", "metavar": null, "name": "--vendored", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--path" ], "help": "Use an external linked checkout at DIR (source: { path: DIR })", "metavar": "DIR", "name": "--path", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Scope the dependency to BOARD (repeatable; subset of supported targets)", "metavar": "BOARD", "name": "--board", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dry-run" ], "help": "Show changes without writing", "metavar": null, "name": "--dry-run", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Add a module to an app's direct dependencies (modules:). The full closure is recomputed from the board profile + direct deps at lock time.", "help": "Alias for `nsx module add`", "name": "add", "path": [ "add" ], "slug": "add", "subcommands": [], "usage": "nsx add [-h] [--app-dir APP_DIR] [--local] [--vendored] [--path DIR]\n [--board BOARD] [--dry-run]\n module" }, { "alias_of": null, "arguments": [], "description": "List and describe packaged board descriptors, or scaffold a custom board that inherits an EVB baseline.", "help": "Inspect packaged boards and scaffold custom boards", "name": "board", "path": [ "board" ], "slug": "board", "subcommands": [ { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Name for the new custom board", "metavar": null, "name": "name", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--from" ], "help": "Parent EVB to inherit from (e.g. apollo510_evb)", "metavar": "BOARD", "name": "--from", "nargs": null, "positional": false, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--app-dir" ], "help": "Application directory (defaults to the nearest app root)", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "Overwrite an existing board directory", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Create a custom board under /boards// that inherits an existing EVB descriptor. Generates board.yaml and a thin board.cmake.", "help": "Scaffold a custom board that inherits an EVB", "name": "board create", "path": [ "board", "create" ], "slug": "board-create", "subcommands": [], "usage": "nsx board create [-h] --from BOARD [--app-dir APP_DIR] [--force]\n [--json]\n name" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--tier" ], "help": "Filter by board tier (e.g. 'evb', 'custom')", "metavar": null, "name": "--tier", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--registered-only" ], "help": "Only show boards registered in the packaged build table", "metavar": null, "name": "--registered-only", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "List packaged board descriptors and their derived SoC/provider facts.", "help": "List available boards", "name": "board list", "path": [ "board", "list" ], "slug": "board-list", "subcommands": [], "usage": "nsx board list [-h] [--tier TIER] [--registered-only] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Board name (e.g. apollo510_evb)", "metavar": null, "name": "board", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Print the derived facts for one board descriptor.", "help": "Show details for a single board", "name": "board show", "path": [ "board", "show" ], "slug": "board-show", "subcommands": [], "usage": "nsx board show [-h] [--json] board" } ], "usage": "nsx board [-h] {list,show,create} ..." }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App name or directory (overrides --app-dir; resolved under ./ and ./examples)", "metavar": null, "name": "app", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Override board from nsx.yml", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--build-dir" ], "help": "Build directory override", "metavar": null, "name": "--build-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Toolchain override (gcc, armclang, atfe)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--sdk-root" ], "help": "Optional out-of-tree AmbiqSuite root passed as NSX_AMBIQSUITE_ROOT_OVERRIDE", "metavar": null, "name": "--sdk-root", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--target" ], "help": "Optional explicit build target", "metavar": null, "name": "--target", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": "8", "exclusive_with": null, "flags": [ "--jobs" ], "help": "Parallel build jobs", "metavar": null, "name": "--jobs", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--update" ], "help": "Re-resolve module constraints to upstream tip and re-vendor before building", "metavar": null, "name": "--update", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--frozen" ], "help": "When a (re)configure is needed (no build.ninja yet), error on any drift between nsx.yml, nsx.lock, and modules/ instead of correcting it; modules missing from modules/ are fetched at their locked revision and verified", "metavar": null, "name": "--frozen", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Build a generated NSX app", "name": "build", "path": [ "build" ], "slug": "build", "subcommands": [], "usage": "nsx build [-h] [--app-dir APP_DIR] [--board BOARD]\n [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN]\n [--sdk-root SDK_ROOT] [--target TARGET] [--jobs JOBS]\n [--update] [--frozen] [--timeout SECONDS]\n [app]" }, { "alias_of": null, "arguments": [], "description": "Inspect the content-addressed module cache or clean every neuralSPOT-X cache under $NSX_CACHE_DIR. Cache hits let `nsx sync` skip git clones for already-seen (commit, content_hash) tuples.", "help": "Inspect or clean neuralSPOT-X on-disk caches", "name": "cache", "path": [ "cache" ], "slug": "cache", "subcommands": [ { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--yes" ], "help": "Confirm deletion (required; without it the command is a dry-run)", "metavar": null, "name": "--yes", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Delete module artifacts, git-artifact hashes, ref resolutions, and their lock files. Subsequent operations repopulate them.", "help": "Remove every neuralSPOT-X cache", "name": "cache clean", "path": [ "cache", "clean" ], "slug": "cache-clean", "subcommands": [], "usage": "nsx cache clean [-h] [--yes]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Show cache location, entry count, and total size on disk.", "help": "Show cache location, entry count, and total size", "name": "cache info", "path": [ "cache", "info" ], "slug": "cache-info", "subcommands": [], "usage": "nsx cache info [-h] [--json]" } ], "usage": "nsx cache [-h] {info,clean} ..." }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App name or directory (overrides --app-dir; resolved under ./ and ./examples)", "metavar": null, "name": "app", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Override board from nsx.yml", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--build-dir" ], "help": "Build directory override", "metavar": null, "name": "--build-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Toolchain override (gcc, armclang, atfe)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--full" ], "help": "Remove the full build directory instead of only running the build-system clean target", "metavar": null, "name": "--full", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--reset" ], "help": "Reset the app to a freshly-cloned state: remove all build*/ directories, the synced modules/ tree, and the .nsx/ folder. Use this before `git pull` to force `nsx configure` to re-sync from scratch.", "metavar": null, "name": "--reset", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "With --reset, discard locally-modified files under modules/ without prompting", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Clean a generated NSX app build directory", "name": "clean", "path": [ "clean" ], "slug": "clean", "subcommands": [], "usage": "nsx clean [-h] [--app-dir APP_DIR] [--board BOARD]\n [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN] [--full]\n [--reset] [--force] [--timeout SECONDS]\n [app]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit the full command graph as machine-readable JSON", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Show the NSX command tree, arguments, and workflow hints.", "help": "Show the NSX command graph for users and agents", "name": "commands", "path": [ "commands" ], "slug": "commands", "subcommands": [], "usage": "nsx commands [-h] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App name or directory (overrides --app-dir; resolved under ./ and ./examples)", "metavar": null, "name": "app", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Override board from nsx.yml", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--build-dir" ], "help": "Build directory override", "metavar": null, "name": "--build-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Toolchain override (gcc, armclang, atfe)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--sdk-root" ], "help": "Optional out-of-tree AmbiqSuite root passed as NSX_AMBIQSUITE_ROOT_OVERRIDE", "metavar": null, "name": "--sdk-root", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--probe-serial" ], "help": "Optional SEGGER J-Link USB serial number to use for generated flash/view targets", "metavar": null, "name": "--probe-serial", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--frozen" ], "help": "Error on any drift between nsx.yml, nsx.lock, and modules/ instead of correcting it; modules missing from modules/ are fetched at their locked revision and verified", "metavar": null, "name": "--frozen", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Configure a generated NSX app with CMake", "name": "configure", "path": [ "configure" ], "slug": "configure", "subcommands": [], "usage": "nsx configure [-h] [--app-dir APP_DIR] [--board BOARD]\n [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN]\n [--sdk-root SDK_ROOT] [--probe-serial PROBE_SERIAL]\n [--frozen] [--timeout SECONDS]\n [app]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App directory to create", "metavar": null, "name": "app_dir", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": "apollo510_evb", "exclusive_with": null, "flags": [ "--board" ], "help": "Target board package suffix", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--soc" ], "help": "Target SoC package suffix (default inferred from board)", "metavar": null, "name": "--soc", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "Allow writing into a non-empty app directory", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--no-bootstrap" ], "help": "Create the app without initializing starter modules", "metavar": null, "name": "--no-bootstrap", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": [ "default", "npu-tflm" ], "default": "default", "exclusive_with": null, "flags": [ "--template" ], "help": "App template (default: Minimal hello-world app (SWO printf loop); npu-tflm: TFLite Micro inference on the Ethos-U85 NPU (Vela model harness, heliaRT ethos-u dispatch))", "metavar": null, "name": "--template", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Create a new standalone NSX app project", "name": "create-app", "path": [ "create-app" ], "slug": "create-app", "subcommands": [], "usage": "nsx create-app [-h] [--board BOARD] [--soc SOC] [--force]\n [--no-bootstrap] [--template {default,npu-tflm}]\n app_dir" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit the full doctor report as machine-readable JSON", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": null, "help": "Check the local NSX toolchain environment", "name": "doctor", "path": [ "doctor" ], "slug": "doctor", "subcommands": [], "usage": "nsx doctor [-h] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App name or directory (overrides --app-dir; resolved under ./ and ./examples)", "metavar": null, "name": "app", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Override board from nsx.yml", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--build-dir" ], "help": "Build directory override", "metavar": null, "name": "--build-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Toolchain override (gcc, armclang, atfe)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--target" ], "help": "Optional executable target to flash", "metavar": null, "name": "--target", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--sdk-root" ], "help": "Optional out-of-tree AmbiqSuite root passed as NSX_AMBIQSUITE_ROOT_OVERRIDE", "metavar": null, "name": "--sdk-root", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--probe-serial" ], "help": "Optional SEGGER J-Link USB serial number to use", "metavar": null, "name": "--probe-serial", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": "8", "exclusive_with": null, "flags": [ "--jobs" ], "help": "Parallel build jobs", "metavar": null, "name": "--jobs", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--update" ], "help": "Re-resolve module constraints to upstream tip and re-vendor before flashing", "metavar": null, "name": "--update", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--frozen" ], "help": "When a (re)configure is needed, error on any drift between nsx.yml, nsx.lock, and modules/ instead of correcting it; modules missing from modules/ are fetched at their locked revision and verified. Note: passing --probe-serial always forces a reconfigure; --frozen only changes how the accompanying module sync behaves, not whether it runs.", "metavar": null, "name": "--frozen", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Build and flash a generated NSX app", "name": "flash", "path": [ "flash" ], "slug": "flash", "subcommands": [], "usage": "nsx flash [-h] [--app-dir APP_DIR] [--board BOARD]\n [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN]\n [--target TARGET] [--sdk-root SDK_ROOT]\n [--probe-serial PROBE_SERIAL] [--jobs JOBS] [--update]\n [--frozen] [--timeout SECONDS]\n [app]" }, { "alias_of": "module list", "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml; required unless --registry-only is used", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--registry-only" ], "help": "List all modules in the packaged registry without app-specific overrides", "metavar": null, "name": "--registry-only", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of a table", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "List modules from the packaged registry, or from the effective registry for an app and mark enabled ones.", "help": "Alias for `nsx module list`", "name": "list-modules", "path": [ "list-modules" ], "slug": "list-modules", "subcommands": [], "usage": "nsx list-modules [-h] [--app-dir APP_DIR] [--registry-only] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--update" ], "help": "Re-resolve constraints to current upstream tip (otherwise reuses prior SHAs)", "metavar": null, "name": "--update", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--module" ], "help": "Only re-resolve the named module (may be repeated; implies --update)", "metavar": null, "name": "--module", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--check" ], "help": "Exit non-zero if nsx.lock is out of date with nsx.yml (do not write); useful in CI", "metavar": null, "name": "--check", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": "Resolve every module declared in nsx.yml to its current upstream commit and content hash, and write the resulting nsx.lock receipt. Does not modify the modules/ tree.", "help": "Resolve modules in nsx.yml to commits and write nsx.lock", "name": "lock", "path": [ "lock" ], "slug": "lock", "subcommands": [], "usage": "nsx lock [-h] [--app-dir APP_DIR] [--update] [--module MODULES]\n [--check] [--timeout SECONDS]" }, { "alias_of": null, "arguments": [], "description": "List, enable, update, and register app-local NSX modules.", "help": "Manage app-local NSX modules", "name": "module", "path": [ "module" ], "slug": "module", "subcommands": [ { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Module name to add", "metavar": null, "name": "module", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--local" ], "help": "Mark the module as local (mirrored from external path; ignored by git)", "metavar": null, "name": "--local", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--vendored" ], "help": "Scaffold a vendored module under modules// (committed in this app's git; never touched by `nsx sync`)", "metavar": null, "name": "--vendored", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--path" ], "help": "Use an external linked checkout at DIR (source: { path: DIR })", "metavar": "DIR", "name": "--path", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Scope the dependency to BOARD (repeatable; subset of supported targets)", "metavar": "BOARD", "name": "--board", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dry-run" ], "help": "Show changes without writing", "metavar": null, "name": "--dry-run", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Add a module to an app's direct dependencies (modules:). The full closure is recomputed from the board profile + direct deps at lock time.", "help": "Add a direct dependency to an app", "name": "module add", "path": [ "module", "add" ], "slug": "module-add", "subcommands": [], "usage": "nsx module add [-h] [--app-dir APP_DIR] [--local] [--vendored]\n [--path DIR] [--board BOARD] [--dry-run]\n module" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Module name to describe", "metavar": null, "name": "module", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--app-dir" ], "help": "Optional app directory containing nsx.yml; when provided, use the app-effective registry", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Describe one module from the packaged or app-effective registry.", "help": "Show detailed metadata for one module", "name": "module describe", "path": [ "module", "describe" ], "slug": "module-describe", "subcommands": [], "usage": "nsx module describe [-h] [--app-dir APP_DIR] [--json] module" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Directory to create for the module skeleton", "metavar": null, "name": "module_dir", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--name" ], "help": "Logical module name (defaults to the directory name)", "metavar": null, "name": "--name", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": [ "algorithm", "backend_specific", "board", "portable_api", "runtime", "sdk_provider", "soc", "tooling" ], "default": "runtime", "exclusive_with": null, "flags": [ "--type" ], "help": "NSX module type for the generated metadata", "metavar": null, "name": "--type", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--summary" ], "help": "One-line module summary to seed into nsx-module.yaml", "metavar": null, "name": "--summary", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": "0.1.0", "exclusive_with": null, "flags": [ "--version" ], "help": "Initial semantic version for the module", "metavar": null, "name": "--version", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dependency" ], "help": "Required module dependency to add to the skeleton; repeat as needed", "metavar": null, "name": "--dependency", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Compatible board to declare; repeat as needed (defaults to *)", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--soc" ], "help": "Compatible SoC to declare; repeat as needed (defaults to *)", "metavar": null, "name": "--soc", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Compatible toolchain to declare; repeat as needed (defaults to arm-none-eabi-gcc)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "Allow writing into a non-empty destination directory", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Scaffold a new NSX custom-module directory with metadata, CMake, headers, and source stubs.", "help": "Create a standard custom-module skeleton", "name": "module init", "path": [ "module", "init" ], "slug": "module-init", "subcommands": [], "usage": "nsx module init [-h] [--name NAME]\n [--type {algorithm,backend_specific,board,portable_api,runtime,sdk_provider,soc,tooling}]\n [--summary SUMMARY] [--version VERSION]\n [--dependency DEPENDENCY] [--board BOARD] [--soc SOC]\n [--toolchain TOOLCHAIN] [--force]\n module_dir" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml; required unless --registry-only is used", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--registry-only" ], "help": "List all modules in the packaged registry without app-specific overrides", "metavar": null, "name": "--registry-only", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of a table", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "List modules from the packaged registry, or from the effective registry for an app and mark enabled ones.", "help": "List modules from the packaged or app-effective registry", "name": "module list", "path": [ "module", "list" ], "slug": "module-list", "subcommands": [], "usage": "nsx module list [-h] [--app-dir APP_DIR] [--registry-only] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Module name", "metavar": null, "name": "module", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--metadata" ], "help": "Path to the module's nsx-module.yaml", "metavar": null, "name": "--metadata", "nargs": null, "positional": false, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--project" ], "help": "Registry project key for this module", "metavar": null, "name": "--project", "nargs": null, "positional": false, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--project-url" ], "help": "Override git project URL", "metavar": null, "name": "--project-url", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--project-revision" ], "help": "Override git project revision", "metavar": null, "name": "--project-revision", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--project-path" ], "help": "Override git project path", "metavar": null, "name": "--project-path", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--project-local-path" ], "help": "Local filesystem path to vendor from", "metavar": null, "name": "--project-local-path", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--override" ], "help": "Override existing module entry", "metavar": null, "name": "--override", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dry-run" ], "help": "Show changes without writing", "metavar": null, "name": "--dry-run", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Register an external module override for a single app and vendor it into that app.", "help": "Register and vendor an external module for one app", "name": "module register", "path": [ "module", "register" ], "slug": "module-register", "subcommands": [], "usage": "nsx module register [-h] --metadata METADATA --project PROJECT\n [--project-url PROJECT_URL]\n [--project-revision PROJECT_REVISION]\n [--project-path PROJECT_PATH]\n [--project-local-path PROJECT_LOCAL_PATH]\n [--app-dir APP_DIR] [--override] [--dry-run]\n module" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Module name to remove", "metavar": null, "name": "module", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dry-run" ], "help": "Show changes without writing", "metavar": null, "name": "--dry-run", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Disable a module for an app and remove vendored files that are no longer needed.", "help": "Disable a module for an app", "name": "module remove", "path": [ "module", "remove" ], "slug": "module-remove", "subcommands": [], "usage": "nsx module remove [-h] [--app-dir APP_DIR] [--dry-run] module" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Search query such as pmu, profiling, uart, or logging", "metavar": null, "name": "query", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--app-dir" ], "help": "Optional app directory containing nsx.yml; when provided, use the app-effective registry and app target context", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Optional board compatibility filter", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--soc" ], "help": "Optional SoC compatibility filter", "metavar": null, "name": "--soc", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Optional toolchain compatibility filter", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--include-incompatible" ], "help": "Include matches that fail the active compatibility filters", "metavar": null, "name": "--include-incompatible", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Search the packaged or app-effective registry using module metadata and optional target-compatibility filters.", "help": "Search modules by intent, capability, or keyword", "name": "module search", "path": [ "module", "search" ], "slug": "module-search", "subcommands": [], "usage": "nsx module search [-h] [--app-dir APP_DIR] [--board BOARD] [--soc SOC]\n [--toolchain TOOLCHAIN] [--include-incompatible]\n [--json]\n query" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Optional single module to refresh", "metavar": null, "name": "module", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--dry-run" ], "help": "Show changes without writing", "metavar": null, "name": "--dry-run", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Refresh vendored modules for an app using the current active registry revisions.", "help": "Refresh enabled modules to current registry revisions", "name": "module update", "path": [ "module", "update" ], "slug": "module-update", "subcommands": [], "usage": "nsx module update [-h] [--app-dir APP_DIR] [--dry-run] [module]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "Path to the nsx-module.yaml file to validate", "metavar": null, "name": "metadata", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Check that an nsx-module.yaml file has all required fields and valid values.", "help": "Validate an nsx-module.yaml file", "name": "module validate", "path": [ "module", "validate" ], "slug": "module-validate", "subcommands": [], "usage": "nsx module validate [-h] [--json] metadata" } ], "usage": "nsx module [-h]\n {list,describe,search,add,remove,update,init,register,validate}\n ..." }, { "alias_of": "create-app", "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App directory to create", "metavar": null, "name": "app_dir", "nargs": null, "positional": true, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": "apollo510_evb", "exclusive_with": null, "flags": [ "--board" ], "help": "Target board package suffix", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--soc" ], "help": "Target SoC package suffix (default inferred from board)", "metavar": null, "name": "--soc", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "Allow writing into a non-empty app directory", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--no-bootstrap" ], "help": "Create the app without initializing starter modules", "metavar": null, "name": "--no-bootstrap", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": [ "default", "npu-tflm" ], "default": "default", "exclusive_with": null, "flags": [ "--template" ], "help": "App template (default: Minimal hello-world app (SWO printf loop); npu-tflm: TFLite Micro inference on the Ethos-U85 NPU (Vela model harness, heliaRT ethos-u dispatch))", "metavar": null, "name": "--template", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Alias for create-app", "name": "new", "path": [ "new" ], "slug": "new", "subcommands": [], "usage": "nsx new [-h] [--board BOARD] [--soc SOC] [--force] [--no-bootstrap]\n [--template {default,npu-tflm}]\n app_dir" }, { "alias_of": null, "arguments": [ { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.lock", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--exit-code" ], "help": "Exit non-zero if any modules are outdated (useful in CI)", "metavar": null, "name": "--exit-code", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of the human-readable table", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": "For each git module in nsx.lock, compare the locked commit against the current upstream tip of the constraint and report any drift.", "help": "Show git modules whose locked commit lags behind upstream", "name": "outdated", "path": [ "outdated" ], "slug": "outdated", "subcommands": [], "usage": "nsx outdated [-h] [--app-dir APP_DIR] [--exit-code] [--json]\n [--timeout SECONDS]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--json" ], "help": "Emit machine-readable JSON instead of human-readable text", "metavar": null, "name": "--json", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "description": "Enumerate connected J-Link probes and print their USB serial numbers.", "help": "List connected SEGGER J-Link debug probes", "name": "probes", "path": [ "probes" ], "slug": "probes", "subcommands": [], "usage": "nsx probes [-h] [--json]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--device" ], "help": "SEGGER J-Link target device name", "metavar": null, "name": "--device", "nargs": null, "positional": false, "repeatable": false, "required": true, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--probe-serial" ], "help": "Optional SEGGER J-Link USB serial number to use", "metavar": null, "name": "--probe-serial", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": [ "debug", "swpoi" ], "default": "debug", "exclusive_with": null, "flags": [ "--kind" ], "help": "Reset primitive", "metavar": null, "name": "--kind", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": "SWD", "exclusive_with": null, "flags": [ "--interface" ], "help": "Debug interface (default: SWD)", "metavar": null, "name": "--interface", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": "4000", "exclusive_with": null, "flags": [ "--speed-khz" ], "help": "Debug interface speed in kHz", "metavar": null, "name": "--speed-khz", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--verify-reconnect" ], "help": "Reconnect after reset and fail if the target is unavailable", "metavar": null, "name": "--verify-reconnect", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Explicitly reset a target with SEGGER J-Link", "name": "reset", "path": [ "reset" ], "slug": "reset", "subcommands": [], "usage": "nsx reset [-h] --device DEVICE [--probe-serial PROBE_SERIAL]\n [--kind {debug,swpoi}] [--interface INTERFACE]\n [--speed-khz SPEED_KHZ] [--verify-reconnect]\n [--timeout SECONDS]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.lock", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": [ "spdx", "cyclonedx" ], "default": "spdx", "exclusive_with": null, "flags": [ "--format" ], "help": "SBOM format (default: spdx \u2014 SPDX 2.3 JSON)", "metavar": null, "name": "--format", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--output", "-o" ], "help": "Write SBOM to FILE instead of stdout", "metavar": "FILE", "name": "-o", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": "Read nsx.lock and emit a single-document SBOM describing every vendored module by upstream URL, commit SHA, and content hash.", "help": "Generate a Software Bill of Materials from nsx.lock", "name": "sbom", "path": [ "sbom" ], "slug": "sbom", "subcommands": [], "usage": "nsx sbom [-h] [--app-dir APP_DIR] [--format {spdx,cyclonedx}]\n [--output FILE]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--frozen" ], "help": "Error on any drift between nsx.yml, nsx.lock, and modules/ instead of correcting it; modules missing from modules/ are fetched at their locked revision and verified", "metavar": null, "name": "--frozen", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--force" ], "help": "Re-vendor every module even if its content_hash matches the lock", "metavar": null, "name": "--force", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": "Re-vendor each module from nsx.lock at its locked commit. Idempotent: modules whose on-disk content already matches the lock are skipped.", "help": "Make modules/ exactly match nsx.lock", "name": "sync", "path": [ "sync" ], "slug": "sync", "subcommands": [], "usage": "nsx sync [-h] [--app-dir APP_DIR] [--frozen] [--force]\n [--timeout SECONDS]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--module" ], "help": "Only update the named module (may be repeated)", "metavar": null, "name": "--module", "nargs": null, "positional": false, "repeatable": true, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--yes" ], "help": "Confirm large updates non-interactively. Required when 3+ modules will move and stdin is not a tty.", "metavar": null, "name": "--yes", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": "Re-resolve every (or selected) module constraint to its current upstream tip, rewrite nsx.lock, and re-vendor changed modules. Equivalent to `nsx lock --update [--module ...] && nsx sync`.", "help": "Re-resolve constraints to upstream tip and sync modules", "name": "update", "path": [ "update" ], "slug": "update", "subcommands": [], "usage": "nsx update [-h] [--app-dir APP_DIR] [--module MODULES] [--yes]\n [--timeout SECONDS]" }, { "alias_of": null, "arguments": [ { "choices": null, "default": null, "exclusive_with": null, "flags": [], "help": "App name or directory (overrides --app-dir; resolved under ./ and ./examples)", "metavar": null, "name": "app", "nargs": "?", "positional": true, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": ".", "exclusive_with": null, "flags": [ "--app-dir" ], "help": "App directory containing nsx.yml", "metavar": null, "name": "--app-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--board" ], "help": "Override board from nsx.yml", "metavar": null, "name": "--board", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--build-dir" ], "help": "Build directory override", "metavar": null, "name": "--build-dir", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--toolchain" ], "help": "Toolchain override (gcc, armclang, atfe)", "metavar": null, "name": "--toolchain", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--sdk-root" ], "help": "Optional out-of-tree AmbiqSuite root passed as NSX_AMBIQSUITE_ROOT_OVERRIDE", "metavar": null, "name": "--sdk-root", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--probe-serial" ], "help": "Optional SEGGER J-Link USB serial number to use", "metavar": null, "name": "--probe-serial", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--frozen" ], "help": "When a (re)configure is needed, error on any drift between nsx.yml, nsx.lock, and modules/ instead of correcting it; modules missing from modules/ are fetched at their locked revision and verified. Note: passing --probe-serial always forces a reconfigure; --frozen only changes how the accompanying module sync behaves, not whether it runs.", "metavar": null, "name": "--frozen", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": [ "--no-reset-on-open" ], "flags": [ "--reset-on-open" ], "help": "Force a target reset after opening the SWO viewer", "metavar": null, "name": "--reset-on-open", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": [ "--reset-on-open" ], "flags": [ "--no-reset-on-open" ], "help": "Open the SWO viewer without issuing the app reset target after attach", "metavar": null, "name": "--no-reset-on-open", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false }, { "choices": null, "default": "400", "exclusive_with": null, "flags": [ "--reset-delay-ms" ], "help": "Milliseconds to wait after opening the SWO viewer before issuing reset", "metavar": null, "name": "--reset-delay-ms", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--duration" ], "help": "Stop the viewer after SECONDS instead of running until interrupted", "metavar": "SECONDS", "name": "--duration", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--capture" ], "help": "Line-stream the SWO output to FILE in addition to stdout", "metavar": "FILE", "name": "--capture", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "--timeout" ], "help": "Wall-clock budget per subprocess (seconds). Kills the whole process group on timeout.", "metavar": "SECONDS", "name": "--timeout", "nargs": null, "positional": false, "repeatable": false, "required": false, "takes_value": true } ], "description": null, "help": "Open the SEGGER SWO viewer for a generated NSX app", "name": "view", "path": [ "view" ], "slug": "view", "subcommands": [], "usage": "nsx view [-h] [--app-dir APP_DIR] [--board BOARD]\n [--build-dir BUILD_DIR] [--toolchain TOOLCHAIN]\n [--sdk-root SDK_ROOT] [--probe-serial PROBE_SERIAL] [--frozen]\n [--reset-on-open | --no-reset-on-open]\n [--reset-delay-ms RESET_DELAY_MS] [--duration SECONDS]\n [--capture FILE] [--timeout SECONDS]\n [app]" } ], "description": "NSX helper for creating and building bare-metal Ambiq apps", "global_arguments": [ { "choices": null, "default": "0", "exclusive_with": null, "flags": [ "-v", "--verbose" ], "help": "Increase CLI verbosity. Repeat for more detail.", "metavar": null, "name": "--verbose", "nargs": "0", "positional": false, "repeatable": true, "required": false, "takes_value": false }, { "choices": null, "default": null, "exclusive_with": null, "flags": [ "-q", "--quiet" ], "help": "Suppress informational and warning logs (errors still surface).", "metavar": null, "name": "--quiet", "nargs": "0", "positional": false, "repeatable": false, "required": false, "takes_value": false } ], "program": "nsx", "usage": "nsx [-h] [-v] [-q]\n {create-app,new,doctor,probes,commands,configure,build,flash,reset,view,clean,lock,sync,outdated,update,module,board,cache,sbom,add,list-modules}\n ..." }