cli_surface

Scope: CLI surface list.
Audience: Contributors and reviewers.
Guarantees: Surface list matches click definitions.
Non-Goals: Usage examples.
Why: This doc exists to record its single responsibility for review.

Overview

This doc defines one responsibility.
Architecture components are defined in Architecture.
Read Cli before edits.
Read Docs Style for context.

Contracts

Each statement is a contract.
Contracts align with tests/unit/test_cli_surface_documentation.py.
Contracts link to Cli and Docs Style.
- api
- api serve
- compare
- export-report
- inspect-candidate
- reproduce
- resume
- run
- --artifacts-dir
- --dry-run
- --execution-mode
- --fasta
- --host
- --json
- --no-docs
- --no-logs
- --output
- --port
- --pretty
- --provider
- --reload
- --rounds
- --sequence

Invariants

Invariants describe stable behavior.
Checks align with tests/unit/test_cli_surface_documentation.py.
Invariants align with Cli.

Failure Modes

Failures are explicit and tested.
Failure coverage aligns with tests/unit/test_cli_surface_documentation.py.
Failures align with Docs Style.

Extension Points

Extensions require tests and docs.
Extensions are tracked in Cli.
Extensions align with tests/unit/test_cli_surface_documentation.py.

Exit Criteria

This doc becomes obsolete when the surface ends.
The replacement is linked in Docs Style.
Obsolete docs are removed.

Code refs: tests/unit/test_cli_surface_documentation.py.