CLI Reference¶
The raes command-line interface is built with Typer
and lives in the canonical raes_cli package.
Main CLI¶
Main entry point for the RAES CLI.
- raes_cli.main.main(version=<typer.models.OptionInfo object>)¶
RAES SDL and runtime CLI.
- Parameters:
version (bool | None)
- Return type:
None
Semantic Commands¶
raes semantic is the offline, read-only human and automation surface.
Every command accepts a file path or - for stdin, requires an explicit
versioned contract selection (defaulting to sdl-yaml/v1 for SDL), and
derives human and deterministic JSON presentation from one typed result.
Offline, read-only command surface for RAES semantic operations.
- raes_cli.semantic.parse_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Perform bounded decoding and typed construction without a validity claim.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.validate_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Run the owning structural and semantic admission checks.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.normalize_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Emit a deterministic normalized representation and provenance.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.resolve_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Resolve and inspect local SDL declarations without acquisition or writes.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.compile_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Compile SDL and emit a bounded typed runtime-model summary.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.transform_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, transform=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Apply one explicitly selected RAES-owned transformation.
- Parameters:
source (str)
contract (str)
transform (TransformProfile)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.inspect_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Inspect admitted typed artifacts without exposing raw values.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
- raes_cli.semantic.conformance_command(source=<typer.models.ArgumentInfo object>, contract=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, migration_policy=<typer.models.OptionInfo object>)¶
Run RAES-owned local conformance checks without invoking a target.
- Parameters:
source (str)
contract (str)
output (OutputFormat)
migration_policy (SDLMigrationPolicy)
- Return type:
None
SDL Commands¶
The raes sdl group contains source-format and legacy module-registry
compatibility commands. Module acquisition, lock generation, and publication
are not part of the stable semantic command contract.
SDL composition and packaging commands.
- raes_cli.sdl.format_source(path=<typer.models.ArgumentInfo object>, write=<typer.models.OptionInfo object>, check=<typer.models.OptionInfo object>)¶
Migrate recognized legacy syntax and emit canonical sdl-yaml/v1.
- Parameters:
path (Path)
write (bool)
check (bool)
- Return type:
None
- raes_cli.sdl.resolve(path=<typer.models.ArgumentInfo object>, lockfile=<typer.models.OptionInfo object>)¶
Resolve SDL imports and write/update the lockfile.
- Parameters:
path (Path)
lockfile (Path | None)
- Return type:
None
- raes_cli.sdl.verify_imports(path=<typer.models.ArgumentInfo object>)¶
Verify lockfile, trust policy, and import expansion.
- Parameters:
path (Path)
- Return type:
None
- raes_cli.sdl.publish(path=<typer.models.ArgumentInfo object>, output_dir=<typer.models.OptionInfo object>, signer_id=<typer.models.OptionInfo object>, private_key=<typer.models.OptionInfo object>)¶
Package an SDL module as an OCI image layout.
- Parameters:
path (Path)
output_dir (Path)
signer_id (str)
private_key (Path | None)
- Return type:
None
Processor Commands¶
Processor declaration and plan-inspection commands.
- class raes_cli.processor.PlanOutputFormat¶
Bases:
str,EnumSerialization format for the compiled plan.
- JSON = 'json'¶
- __new__(value)¶
- raes_cli.processor.manifest()¶
Print the reference processor manifest.
- Return type:
None
- raes_cli.processor.plan(sdl=<typer.models.ArgumentInfo object>, manifest_path=<typer.models.OptionInfo object>, output_format=<typer.models.OptionInfo object>)¶
Compile an SDL scenario and emit its execution plan as published-contract JSON.
Plans against the reference dry-run manifest by default;
--manifesttargets an explicitly supplied backend-manifest-v2. stdout is a single JSON envelope whoseprovisioning/orchestration/evaluationmembers each validate against the published plan contracts. A plan produced with error diagnostics is still emitted in full, with a non-zero exit status. This is a read-only dry run: it does not apply, provision, or start anything.- Parameters:
sdl (Path)
manifest_path (Path | None)
output_format (PlanOutputFormat)
- Return type:
None
- raes_cli.processor.satisfiability(sdl=<typer.models.ArgumentInfo object>, profile=<typer.models.OptionInfo object>)¶
Emit replayable whole-scenario satisfiability evidence as JSON.
Exit status 0 means satisfiable or unsatisfiable, 2 means the authored scenario uses a construct outside the selected theory, and 1 means the input or operational boundary failed. Unsupported is a typed, fail-closed analysis result rather than a satisfiability conclusion.
- Parameters:
sdl (Path)
profile (str)
- Return type:
None
- raes_cli.processor.exploit_path(input_json=<typer.models.ArgumentInfo object>, profile=<typer.models.OptionInfo object>)¶
Emit replayable typed exploit-path analysis evidence as JSON.
Exit status 0 means the supported query completed with a valid or invalid path result, 2 means typed unsupported input, and 1 means malformed input or operational failure.
- Parameters:
input_json (Path)
profile (str)
- Return type:
None
Conformance Commands¶
Backend conformance commands exposed through raes conformance backend.
- raes_cli.conformance.backend(profile=<typer.models.OptionInfo object>, fixtures_root=<typer.models.OptionInfo object>, profiles_root=<typer.models.OptionInfo object>)¶
Run the published backend conformance fixture suite for
profile.Reads the profile-to-contract requirements from
contracts/profiles/backend/<profile>.jsonand the fixture corpus fromcontracts/fixtures/(or the supplied overrides). Exits non-zero when any case or top-level diagnostic fails so CI gates can wire it in. A missing/malformed/mislabeled profile JSON surfaces as a structuredconformance.profile-load-faileddiagnostic in the report.- Parameters:
profile (str)
fixtures_root (Path | None)
profiles_root (Path | None)
- Return type:
None