Skip to content
neuralSPOT-X
API reference
HELIA HUB

nsx clean

Clean a generated NSX app build directory

nsx clean [-h] [--app-dir APP_DIR] [--board BOARD]
[--build-dir BUILD_DIR] [--toolchain TOOLCHAIN] [--full]
[--reset] [--force] [--timeout SECONDS]
[app]
Positional arguments
OptionValueDefaultDescription
appvalueoptionalApp name or directory (overrides --app-dir; resolved under ./ and ./examples)
Options for nsx clean
OptionValueDefaultDescription
--app-dir APP_DIRvalue.App directory containing nsx.yml
--board BOARDvalueoptionalOverride board from nsx.yml
--build-dir BUILD_DIRvalueoptionalBuild directory override
--toolchain TOOLCHAINvalueoptionalToolchain override (gcc, armclang, atfe)
--fullflagoptionalRemove the full build directory instead of only running the build-system clean target
--resetflagoptionalReset 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.
--forceflagoptionalWith --reset, discard locally-modified files under modules/ without prompting
--timeout SECONDSvalueoptionalWall-clock budget per subprocess (seconds). Kills the whole process group on timeout.

--reset is broader than a normal or --full clean: it removes all build*/ directories, the synced modules/ tree and .nsx/, restoring freshly cloned app state. Review local module changes before combining it with --force, which discards modified files under modules/ without prompting.

Terminal window
cd <app-dir>
nsx clean

Run nsx commands --json for the authoritative machine-readable argument schema.

--app-dir names the app directory containing nsx.yml; when it is omitted NSX searches upward from the current directory. The positional app argument overrides --app-dir and is resolved under the current directory and under examples/.

-v/--verbose, -q/--quiet are parsed by nsx itself, so they go before the command name, as nsx -v clean.