Skip to main content

Global Options

Global Options

Root Callback

Apply banner, help, version, dry-run, debug, and log-level behavior before any selected command.

Commandcusty [GLOBAL_OPTIONS] COMMAND

Category

Reference

Quick Command

custy --dry-run run release
placementresolutionloggingsafety
Root Options
6
Placement
Before command
Log Levels
5
Shared State
AppContext

Options​

Command Options

Available command-line options.

--no-banner
Optional
Hide the startup banner. Useful for automation and compact terminal output.
Defaultfalse
Examplecusty --no-banner validate
--help-h
Optional
Render root help. The current root callback explicitly exits with status 1 after displaying it.
Defaultfalse
Examplecusty --help
--version-v
Optional
Display the installed Custy package version. The current callback exits with status 1 after displaying it.
Examplecusty --version
--dry-run / --no-dry-run-dr / -Dr
Optional
Enable or disable simulation for supported effects. Resolution falls back to tool.custy.cli.execution.dry_run.
Defaultconfiguration, then false
Examplecusty --dry-run run release
--debug / --no-debug-dbg / -Dbg
Optional
Enable or disable diagnostic output. Internally this is resolved through the inverse no_debug configuration property.
Defaultconfiguration
Examplecusty --debug commit
--log-level-ll
Optional
Set critical, error, warning, info, or debug output. Values are case-insensitive.
Defaulttool.custy.logging.level, then INFO
Examplecusty --log-level debug tag

Placement Rule

Correct and incorrect placement
bash
# Correct: root option before the command
custy --dry-run changelog generate
custy --log-level DEBUG cleanup brancheses

# Incorrect: root option after a command that does not own it

custy --dry-run changelog generate

Some experimental routes define local options with similar names. Do not use that exception to infer that every command accepts root options after its name.

Resolution and Shared Context

  • --dry-run resolves through CLI input, then tool.custy.cli.execution.dry_run, then false.
  • Debug behavior resolves through the inverse tool.custy.cli.execution.no_debug property.
  • --log-level resolves through CLI input, then tool.custy.logging.level, then INFO.
  • The root callback stores dry-run, debug, and log level in AppContext so direct commands and pipelines can reuse one request-scoped state object.
  • --no-banner, --help, and --version are root presentation controls and do not come from project configuration.

Continue

Related Commands

Commands commonly used together with this command.

CLI Reference

Choose the command that receives these root options.

Dry Run

Understand simulated and non-simulated behavior.