Skip to main content

Module exit_code

Module exit_code 

Source
Expand description

What a command’s exit status means.

exit_code 0 "all checks passed"
exit_code 1 "a check failed"
exit_code 2 "configuration error"

Declared at the root for the CLI-wide convention and on a command for what it adds or refines. A man page conventionally carries an EXIT STATUS section and this project’s renderer had no way to fill one; an agent reading the spec through usage mcp had no way to tell “one check failed” from “the tool broke”.

Folding is per code and nearest-wins, so exit_code 1 "a check failed" on a command refines a CLI-wide exit_code 1 "error" rather than replacing the whole table. The alternative — a command that redeclares anything owns the full set — would make every command restate 0 and 130.

Structs§

SpecExitCode
One documented exit status.

Functions§

effective_exit_codes
The exit codes in effect for a command, CLI-wide declarations folded in.
effective_exit_codes_ref
Reference-based form used by tree walkers that already hold the command chain.