Installing the `ranvier` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install ranvier-cli

It will make the ranvier command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall ranvier-cli uninstalls.

Back to the crate overview.

Readme

Ranvier CLI

The Ranvier CLI provides schematic and trace tooling for the Ranvier Typed Decision Engine.

Install

cargo install ranvier-cli

Usage

ranvier --help

Common Commands

Generate a schematic JSON from a workspace example:

ranvier schematic basic-schematic --output schematic.json

Generate trace projection artifacts from a schematic:

ranvier status projection-from-schematic basic-schematic \
  --output ./dist/trace \
  --circuit-version 0.1.0

Generate projection artifacts from a timeline capture:

ranvier status projection-from-timeline ./dist/sample.timeline.json \
  --output ./dist/trace \
  --service "Ranvier Service" \
  --circuit-id order_api \
  --circuit-version 0.1.0

Generate projection artifacts directly from an example:

ranvier status projection-from-example order-processing-demo \
  --output ./dist/trace-order \
  --service "Ranvier Service" \
  --circuit-id order_processing \
  --circuit-version 0.1.0

Run the repository smoke check for projection-from-example:

pwsh ./cli/scripts/smoke_projection_from_example.ps1

Run projection drift check (example -> timeline -> projection equivalence):

pwsh ./cli/scripts/projection_drift_check.ps1

Notes

The CLI expects example names from the workspace when used in repository mode.
Projection artifacts feed the inspector endpoints /trace/public and /trace/internal.

Installing the ranvier executable

Installing the `ranvier` executable