api_commands

• diff_api
• dump_api

Symbol Details

cli_command: diff_api

• source

  Since: 0.1.0

def diff_api(*, baseline_ref: str | None = ...):
    ...

Show API changes between baseline and dev dump.

CLI Options:

Flag	Type	Default	Description
--baseline	str | None	required	Git tag/ref to compare against (default: {pkg}.api.yaml file)

Changes

Version	Change
0.1.0	Made public

cli_command: dump_api

• source

  Since: 0.1.0

def dump_api(*, output: Path | None = ..., dev: bool = False):
    ...

Dump public API to YAML for diffing and breaking change detection.

CLI Options:

Flag	Type	Default	Description
-o, --output	Path | None	required	Output file path
--dev	bool	False	Write to -dev file (gitignored for local comparison)

Changes

Version	Change
0.1.0	Made public