CLI reference

Every page below is generated from the nsx argument parser, so it describes the version of NSX you installed. nsx <command> --help prints the same information at the terminal, and nsx commands --json returns the whole tree as JSON.

Commands

• nsx board Inspect packaged boards and scaffold custom boards
• nsx build Build a generated NSX app
• nsx cache Inspect or clean neuralSPOT-X on-disk caches
• nsx clean Clean a generated NSX app build directory
• nsx commands Show the NSX command graph for users and agents
• nsx configure Configure a generated NSX app with CMake
• nsx create-app Create a new standalone NSX app project
• nsx doctor Check the local NSX toolchain environment
• nsx flash Build and flash a generated NSX app
• nsx lock Resolve modules in nsx.yml to commits and write nsx.lock
• nsx module Manage app-local NSX modules
• nsx outdated Show git modules whose locked commit lags behind upstream
• nsx probes List connected SEGGER J-Link debug probes
• nsx reset Explicitly reset a target with SEGGER J-Link
• nsx sbom Generate a Software Bill of Materials from nsx.lock
• nsx sync Make modules/ exactly match nsx.lock
• nsx update Re-resolve constraints to upstream tip and sync modules
• nsx view Open the SEGGER SWO viewer for a generated NSX app

Aliases

• nsx add runs nsx module add.
• nsx list-modules runs nsx module list.
• nsx new runs nsx create-app.