Skip to content

gz plan

Create ADRs and run plan-audit checks.

gz plan is a parent verb that groups ADR authoring and plan-OBPI alignment verification. All real work happens in its subcommands; invoke gz plan without a subcommand to see this help.


Usage

Bash
gz plan {create,audit} [OPTIONS]

Subcommands

Subcommand Purpose Details
gz plan create Create a new ADR scaffold Taxonomy-aware: the required --kind routes output and frontmatter. Feature requires non-0.0.x semver and books adr_created; pool writes a flat backlog ADR and books nothing; foundation is refused where the kind is closed, as it is in gzkit (ADR-0.34.0).
gz plan audit Structural prerequisite check for plan-OBPI alignment Verifies ADR package, OBPI brief, plan file, and allowed-path containment before implementation begins.

Options

Option Description
-h, --help Show help and exit
-q, --quiet Suppress non-error output
-v, --verbose Enable verbose output
--debug Enable debug mode with full tracebacks

Examples

Bash
gz plan create my-feature --kind feature --semver 0.1.0 --lane lite
gz plan audit OBPI-0.1.0-01

Exit Codes

Code Meaning
0 Success
1 User/config error
2 System/IO error
3 Policy breach

See Also