Reference
The Nox
documentation.
Nox is a Rust build system and task runner. These pages describe the behavior implemented by the current binary.
What Nox is, then how to use it.
New to build tools or programming? Start with About Nox. It explains the build system, task runner, dependency graph, and day-to-day workflow in either technical or no-prerequisites language.
From a Nox source checkout, bootstrap the executable with Cargo, then use Nox from the project root containing nox.build.
cargo build --release
./target/release/nox help
nox setup build
nox compile -C buildThe command reference.
nox init
Analyze a directory and generate missing project files for Nox.
nox init my-project --language rustnox setup
Parse and validate nox.build, detect the C toolchain, and write build state.
nox setup buildnox compile
Compile changed sources and link targets. `build` remains an alias.
nox compile -C buildnox rebuild
Reconfigure and compile every target from scratch.
nox rebuild --releasenox clean
Remove generated build artifacts while preserving installed files.
nox cleannox validate
Check duplicate targets, missing dependencies, and dependency cycles.
nox validatenox status
Show the selected build state, project metadata, and toolchain.
nox statusnox targets
List declared targets in nox.build.
nox targetsnox graph
Print targets in dependency order.
nox graphnox riders
List the language backends compiled into Nox.
nox ridersnox install
Build and copy targets marked install = true into the selected prefix.
nox install --prefix "$HOME/.local"nox uninstall
Remove installed targets without compiling.
nox uninstallnox run
Build and run a selected project target or a supported source file.
nox run noxnox nomlfmt
Format one NOML file or every NOML file under a directory.
nox nomlfmt .nox test
Run the task named test from noxfile.
nox testnox task
Find a named task in noxfile and execute its run command.
nox task formatnox tasks
List noxfile task names alphabetically.
nox tasksnox version
Print the embedded Nox version.
nox versionnox bump-version
Bump or set VERSION and matching references.
nox bump-version minornox help
Show general or command-specific help.
nox help runTwo files, two jobs.
nox.build declares the project, targets, source files, compiler settings, and dependencies. noxfile is optional task automation. It does not replace the compilation graph.
The parts behind the command.
Go deeper into Nox's build pipeline, compiler detection, project workflows, contributor testing, and NOML.