Global options
Purpose
Global options configure command-independent CLI behavior and may appear before or after the command name.
Synopsis
rux [global-options] <command> [command-options] [operands]
Both --option value and --option=value are accepted for options that take a value. Only rux run accepts --; every following token is passed unchanged to the child program.
Behavior
-q/--quiet and -v/--verbose conflict. Help and version exit 0. Unknown options, missing values, invalid color values, conflicts, and incorrect operand counts exit 2 and are written to stderr.
Help is available as rux help, rux help <command>, or command-level -h/--help. Close command and option spellings receive a suggestion.
Options
| Option | Description |
|---|---|
--color <auto|always|never> | Control colored console output |
-h, --help | Show help information |
--manifest <path> | Use the specified manifest file instead of Rux.toml |
-q, --quiet | Do not show log messages |
-v, --verbose | Use verbose output |
-V, --version | Show version information |
Color
--color accepts exactly auto, always, or never. An explicit CLI value overrides the environment. In auto mode, stdout and stderr terminal attachment are detected independently.
Manifest
--manifest <path> selects a specific manifest instead of searching upward for Rux.toml.
Output and exit status
Primary output and structured JSON use stdout. Progress, warnings, and errors use stderr. Success, help, and version exit 0; invalid CLI usage exits 2; operational and compiler failures exit 1.
Examples
rux --manifest examples/Rux.toml check
rux build --color=never
rux --quiet test
rux help build
rux help --json
Environment variables
- A non-empty
NO_COLORdisables color in auto mode. TERM=dumbdisables color in auto mode.- An explicit
--color alwaysor--color neveroverrides both variables.