CLI reference

Reference · CLI

Reference purpose — Use the CLI as a shared vocabulary for creation, verification, local operations, and release work.

Commands that are discoverable, scriptable, and consistent with CI.

Key concepts

Exit code

Automation signal

Output

Human and machine readable

Mutation

Explicit

Reference model

Contract summary

Property	Definition	Review question
Exit code	Automation signal	Zero means the contract passed.
Output	Human and machine readable	Do not require screen scraping.
Mutation	Explicit	Show what will change before acting.

Interpretation

A CLI becomes infrastructure when teams use it in automation; ambiguous output and hidden side effects then become operational debt.

Reference note A good command leaves less ambiguity than the manual sequence it replaces.

Implementation notes

Engineering move	Guidance
List the command contract	Define arguments, defaults, files touched, and exit codes.
Keep dry runs safe	Preview migrations, releases, or destructive work where possible.
Make output scriptable	Use stable text or structured output for automation.
Run CI parity	Ensure local checks invoke the same underlying commands as CI.

Decision lens

Mode	Practical emphasis
Explore	Use help and inspection commands without mutation.
Develop	Generate or verify local artifacts.
Release	Run checks, package inspection, and publication gates.

Start

Core

Platform

Reference

Operations

CLI reference

Reference · CLI

Key concepts

Exit code

Output

Mutation

Reference model

Contract summary

Interpretation

Implementation notes

Decision lens

References

​CLI reference

​Reference · CLI

​Key concepts

Exit code

Output

Mutation

​Reference model

​Contract summary

​Interpretation

​Implementation notes

​Decision lens

​Related topics

​References

CLI reference

Reference · CLI

Key concepts

Reference model

Contract summary

Interpretation

Implementation notes

Decision lens

Related topics

References