Crate boxology_cli 

Compatibility facade for the effectful Boxology command core.

The installed boxology binary remains in this package. Reusable command behavior lives in boxology-cli-core and is re-exported here so existing library consumers keep the same seam.

Structs

BaseDiffInputs

Base-revision packages, changed paths, and tree object index for diff ownership.

BaseError

A stable failure to resolve the explicit base or read one of its schema objects.

CapturedOutput

Captured stdout and stderr from one trusted command.

CheckClassificationError

A coded check-classification failure with schema or classifier diagnostics.

CheckComposition

Live local classifier and check boxes assembled for the installed CLI.

ClassifierComposition

Live local classifier box assembled for the CLI composition.

ClassifyError

A stable classification failure with the underlying schema or classifier diagnostics.

CommandSpec

Injectable trusted command: program name plus argv after the program.

CompareDifference

One package-relative difference between checked-in and regenerated derived output.

DuplicatePackages

Caller supplied the same package id more than once; not a repository defect.

ExecuteError

A stable execution failure with an optional verbatim generator or writer cause.

ExecutePlans

Lazy sequential multi-plan execution seam used by boxology generate.

GenerationPlan

The pure inputs needed by the next generation-execution slice.

GitToolError

The Git executable could not be started for a base check.

Outcome

The files changed by one accepted execution, in deterministic logical-path order.

PackageSchemas

Supplied base and checked-in schema bytes for one package.

PlanError

A stable planning failure with a validated logical path and no filesystem payload.

QualityCommand

One declared quality command bound to its package and manifest path.

ResolvedBase

One validated base commit, resolved once per check.

ResolvedImport

One declared import resolved to the imported package’s checked-in schema.

SpawnError

The trusted command executable could not be started.

ToolStep

Outcome of one external check step: completion plus optional captured tool text.

WalkError

A payload-safe failure while materializing raw workspace filesystem inputs.

WalkedWorkspace

Raw filesystem material for boxology-workspace.

Enums

BaseInputsError

Failure while assembling base-revision ownership inputs.

BaseSchemasError

Failure while assembling current and base-revision package schemas.

ClassifyStepError

Failure from classify_step: caller misuse or a coded package failure.

CompareStepError

A planning or generation failure while comparing derived output.

DefaultBase

Outcome of resolving the no-flag default base against the fixed v0 branch main.

DifferenceKind

Why one checked-in derived artifact does not match regeneration.

Constants

CARGO_METADATA_ARGS

The exact argv passed to the one Cargo metadata invocation owned by the CLI.

Functions

base_diff_inputs

Loads base packages, the working-tree changed set, and the full tree object index.

base_diff_inputs_with_candidate

Loads diff inputs, using candidate declarations only when the managed root has no base object.

base_package_schemas

Assembles schema pairs for every current generation plan against one resolved base.

cargo_metadata_command

Builds the captured Cargo metadata command for root.

classify

Classifies checked-in and regenerated schema bytes through the strict reader and classifier.

classify_step

Classifies each package’s base-revision and checked-in schema bytes.

clippy_spec

Builds denied-warning workspace Clippy matching the 08 baseline.

compare_plans

Compares already-planned contract generations with their checked-in derived files.

compare_step

Compares every contract-generation plan with its checked-in derived files.

composition_step

Reads every plan-authoritative checked-in schema and validates all compositions.

execute

Executes one plan against root, reading package inputs, generating its tree, and writing it.

execute_plans

Returns a lazy executor that runs plans in iterator order against root.

fmt_packages

Cargo package names selected for formatting: non-derived owned crate manifests only.

fmt_spec

Builds cargo fmt --check -p … over the manifest-derived hand-authored selection.

lock_spec

Builds full locked Cargo metadata matching the 08 baseline step-4 freshness check.

plan

Selects contract-generator candidates and assembles their pure plans in import-dependency order.

quality_specs

Flattens declared quality commands in package-id then declaration order.

resolve_base

Resolves an explicit base revision to one validated commit object id.

resolve_default_base

Resolves the no-flag default base: merge base of HEAD with the fixed v0 branch main.

run_clippy_step

Runs Clippy through the injectable runner.

run_command

Runs spec at root through the host process API.

run_fmt_step

Runs formatting, or returns passed when the manifest-derived selection is empty.

run_lock_step

Runs full locked Cargo resolution through the injectable runner.

run_quality_step

Runs every declared quality command, continuing after nonzero exits.

run_test_step

Runs workspace tests through the injectable runner.

test_spec

Builds workspace tests matching the 08 baseline.

walk

Walks root without following symlink entries. Real .git and target directories are pruned at every depth; every other entry must have a valid RelativePath.

Type Aliases

CommandRunner

Injectable runner used by tool steps and tests.