rux fmt

Purpose

Format all *.rux source files and *.toml manifests

Synopsis

rux fmt [options]

Behavior

Formats both Src/**/*.rux and Rux.toml by default. --source-only and --manifest-only are mutually exclusive. --check reports drift without writing files.

Arguments

This command accepts no operands.

Options

OptionDescription
--checkCheck file formatting status without modifying source files
--manifest-onlyFormat only the manifest configuration file (Rux.toml)
--source-onlyFormat only Rux source files

Global options may appear before or after the command. See Global options.

Output and exit status

Primary results are written to stdout. Progress, warnings, and errors are written to stderr.

Success exits 0, invalid command-line usage exits 2, and compiler, validation, filesystem, network, or generation failures exit 1 unless stated otherwise above.

Examples

rux fmt
rux fmt --check
rux fmt --manifest-only

Environment variables

This command defines no command-specific environment variables.

The global color environment behavior is described under Global options.