CLI Reference
The Rux compiler is the source of truth for this reference. The checked-in contract was generated by rux 0.4.0 using help schema version 1.
Command syntax
rux [global-options] <command> [command-options] [operands]
Global options may appear before or after the command. Value options accept separated and equals forms. Only rux run treats tokens after -- as child-program arguments.
Commands
| Command | Purpose |
|---|---|
rux add | Add a dependency to the manifest |
rux build | Build the current package |
rux check | Check package source code for errors without building |
rux clean | Remove build artifacts |
rux doc | Generate package documentation |
rux fmt | Format source files and manifests |
rux help | Show help information |
rux info | Show package metadata and manifest information |
rux init | Initialize a Rux package in the current directory |
rux install | Install dependencies |
rux lint | Lint package source files |
rux list | List dependencies |
rux login | Store a registry token for publishing |
rux logout | Remove a stored registry token |
rux new | Create a new Rux package |
rux pack | Build the publishable package archive |
rux publish | Publish the package to the registry |
rux remove | Remove a dependency from the manifest |
rux run | Build and run the main executable |
rux test | Run all test targets |
rux uninstall | Uninstall dependencies |
rux update | Update dependencies |
rux version | Show version information |
Streams and exit status
Primary output and JSON use stdout. Progress, warnings, and errors use stderr. Success, help, and version exit 0; invalid CLI usage exits 2; compiler or operational failures exit 1. rux run returns the child program's exit code after a successful build.
Structured help
rux help --json returns the full stable contract. rux help <command> --json returns one command. Both use schemaVersion: 1 and omit build timestamps.