rux help
Purpose
Show help information
Synopsis
rux help
Behavior
Without an operand, lists all commands and global options. With a command operand, prints command help. --json emits schema version 1 with stable program, command, usage, argument, option, example, and documentation URL data; build timestamps are intentionally absent.
Arguments
| Argument | Required | Description |
|---|---|---|
command | No | The command whose help should be shown |
Options
| Option | Description |
|---|---|
--json | Print the versioned command contract as JSON |
Global options may appear before or after the command. See Global options.
Output and exit status
Help and JSON are written to stdout.
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 help
Environment variables
This command defines no command-specific environment variables.
The global color environment behavior is described under Global options.