Manual

Ranvier core concepts and workflows.

Use this manual as a concise reference for Ranvier primitives, layer boundaries, and CLI tooling.

Layer Model

Core

Protocol-agnostic contracts: Transition, Outcome, Bus, Schematic.

Runtime

Axon execution engine with explicit composition.

Adapter

Ingress/Egress boundaries. HTTP lives here, not in core.

Core Types

Transition: async contract from state to Outcome.

Outcome: Next, Branch, Jump, Emit, Fault.

Bus: type-indexed resource container.

Schematic: nodes and edges extracted from Axon.

Ingress Builder

Ranvier::http()
    .bind("127.0.0.1:3000")
    .route("/", axon)
    .fallback(not_found)
    .run(resources)
    .await?;

Ranvier::http() is not a web server. It is the ingress builder that wires protocol traffic into Axon execution.

CLI Tooling

Schematic Export

ranvier schematic basic-schematic --output schematic.json

Projection From Schematic

ranvier status projection-from-schematic basic-schematic --output ./dist/trace

Projection From Timeline

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

Inspector + Trace Artifacts

RANVIER_TRACE_PUBLIC_PATH=./dist/trace/trace.public.json
RANVIER_TRACE_INTERNAL_PATH=./dist/trace/trace.internal.json
RANVIER_TIMELINE_MODE=overwrite
RANVIER_TIMELINE_MAX_EVENTS=1000
RANVIER_TIMELINE_SAMPLE_RATE=1.0
RANVIER_TIMELINE_ADAPTIVE=fault_branch