CLI Manual

Command surface and artifact flow.

Use this page for reproducible CLI paths from local workspace examples.

Intro Tutorial Manual Hub Samples

Core Concepts

CLI Boundary

CLI drives export/verification flows, not runtime request serving.

Use generated artifacts to review structure before deployment.

Artifact Path

Schematic output captures static flow shape.

Projection output feeds inspector/diagnostics checks.

Capability Snapshot

Can

Inspect command surface and usage quickly with `ranvier --help`.

Export schematic artifacts from workspace examples.

Compare schematic changes across git refs with `ranvier schematic diff`.

Run structural policy checks from TOML rules and fail with non-zero exit on violations.

Validate schematic schema-version compatibility before processing input artifacts.

Generate trace projection artifacts from schematic/timeline/example inputs.

Scaffold new projects from macro-first templates via `ranvier new`.

Run version migration workflows via `ranvier migrate` with dry-run/verbose/JSON modes.

Browse and fetch example schematics from remote or local catalogs via `ranvier catalog list/fetch/verify`.

Execute API test collections headlessly via `ranvier test` — sequential HTTP execution with assertion evaluation (10 operators), capture chaining, environment interpolation, glob support, and output in text/JSON/JUnit XML formats for CI integration.

Scaffold new projects interactively via `ranvier new` with dialoguer-based template selection (10 templates), dependency chooser (DB/Auth/Observability), auto-generated `.ranvier/collections/` and `.env.example`.

Generate self-contained HTML status pages from Schematic JSON via `ranvier status build` and `ranvier status from-schematic`. Restored from ranvier-status crate consolidation in v0.21.

Cannot yet

Quickstart

ranvier --help
ranvier schematic basic-schematic --output schematic.json
ranvier status projection-from-timeline ./dist/sample.timeline.json --output ./dist/trace

Primary Workflow

Inspect command surface and required arguments.

Generate schematic artifacts from local examples.

Generate projection artifacts for inspector/diagnostics review.

Verification Commands

CLI command surface cargo run -- --help

Schematic export command cargo run -- schematic basic-schematic --output schematic.json

Schematic diff command surface cargo run -- schematic diff --help

Schematic policy check command surface cargo run -- schematic policy check --help

Catalog list command cargo run -- catalog list --local --json

Catalog fetch + verify E2E

cargo run -- catalog fetch basic-schematic --local --output /tmp/basic.json && cargo run -- catalog verify /tmp/basic.json

Sample Reproduction Page

Reproduction steps are available at /manual/samples/cli.

For latest capability status and artifact versions, check /status.