Ranvier
KR Start Tutorial

Status

Submodule capabilities at a glance.

Check what each module can do now and how to verify it in one place.

Updated: 2026-02-07

ranvier

Core Rust module for first users to build typed decision flows, run canonical examples, and connect HTTP adapters.

Stage: Stabilizing
Commit: 5808955 Last verified: 2026-02-07

Versioning

Current 0.1.0
Line 0.1.x
Channel stable
Release status released
Version source ranvier/Cargo.toml [workspace.package.version]

Artifacts

ranvier-core crates.io 0.1.0 released
ranvier-runtime crates.io 0.1.0 released
ranvier-http crates.io 0.1.0 released
ranvier-std crates.io 0.1.0 released
ranvier crates.io 0.1.0 released
ranvier-status crates.io 0.1.1 released
ranvier-synapse crates.io 0.1.0 released
ranvier-inspector crates.io 0.1.0 released

Can do now

  • Define typed decision flows with Axon and Transition/Outcome contracts.
  • Connect HTTP ingress/egress adapters while keeping core protocol-agnostic.
  • Run canonical examples in the workspace (hello-world, typed-state-tree, basic-schematic).
  • Export runtime structure as Schematic for visualization and tooling handoff.
  • Apply inspector role/tenant header baseline with environment configuration.

Not ready yet

  • Ingress router DSL for large route sets is not finalized yet.
  • Bus capability/allowlist guardrails are not enforced at code level yet.
  • Schematic diff/projection automation is still maturing beyond baseline specs.
  • Token/claim-to-role mapping for inspector auth headers is not built into core runtime and depends on deployment gateway policy.

Verification commands

Workspace example build pass
cargo check --workspace
Typed flow example run pass
cargo run -p typed-state-tree

References

  • ranvier/README.md

cli

First-user command-line tool to inspect Ranvier command surface and generate schematic/projection artifacts from examples.

Stage: Stabilizing
Commit: ddec7c4 Last verified: 2026-02-07

Versioning

Current 0.1.1
Line 0.1.x
Channel stable
Release status released
Version source cli/Cargo.toml [package.version]

Artifacts

ranvier-cli crates.io 0.1.1 released

Can do now

  • Show command surface and usage quickly with ranvier --help.
  • Export schematic artifacts from workspace examples via `--schematic` mode.
  • Generate trace projection artifacts from schematic, timeline, or example flows.
  • Forward generated projection artifacts to inspector endpoints for review.

Not ready yet

  • Repository-mode commands assume local workspace examples and are not packaged for remote catalogs.
  • End-to-end remote catalog workflows are not provided as a stable distribution path yet.

Verification commands

CLI command surface pass
cargo run -- --help
Schematic export command pass
cargo run -- schematic basic-schematic --output schematic.json

References

  • cli/README.md

studio

First-user visual inspector app for loading Ranvier schematics, reviewing overlays, and exporting filtered incident data.

Stage: Active
Commit: 0c4028e Last verified: 2026-02-07

Versioning

Current 0.0.1
Line 0.0.x
Channel preview
Release status internal
Version source studio/package.json [version]

Artifacts

ranvier-studio npm 0.0.1 internal

Can do now

  • Load and render schematic node/edge graphs in the Studio viewer.
  • Switch overlay modes (none, traffic, latency, errors) in the same circuit context.
  • Attach to a remote inspector endpoint and load /schematic and trace overlays.
  • Send optional Bearer auth plus role/tenant headers for remote attach requests.
  • Filter and group failure history in overlay panel for quick triage.
  • Export visible failure history as JSON with optional redact/profile presets.
  • Add checksum/signature metadata when exporting reports for integrity checks.

Not ready yet

  • Studio is not the primary IDE surface for inline source navigation (VSCode extension scope).
  • Final role/tenant enforcement still depends on upstream server or gateway policy.
  • Desktop release/signing automation is not yet offered as a stable public workflow.

Verification commands

Load remote schematic in Studio pass
Studio UI > Attach endpoint > Load /schematic
Refresh trace overlays in Studio pass
Studio UI > Load /trace/public and /events overlays
Export filtered failure report pass
Studio UI > Failure panel > Export JSON (redact/profile optional)

References

  • studio/README.md

vscode

First-user IDE companion extension for Ranvier development with circuit visualization, source jump, diagnostics overlays, and issue navigation in VSCode.

Stage: Active
Commit: d6c90c5 Last verified: 2026-02-07

Versioning

Current 0.0.5
Line 0.0.x
Channel preview
Release status published
Version source vscode/package.json [version]

Artifacts

ranvier-vscode vscode-marketplace 0.0.5 released

Can do now

  • Render circuit graphs from workspace `schematic.json`, list nodes in `Ranvier Circuit Nodes`, and keep graph+panel in sync.
  • Attempt source jump from selected circuit nodes when `source_location` mapping is present.
  • Highlight mapped nodes from the active editor file/line to connect code context and circuit context.
  • Read `diagnostics.json` and show node severity overlays in webview, sidebar, and VSCode Problems panel.
  • Reveal the mapped circuit node from the current editor line via command palette.
  • Navigate next/previous node-linked issues from command palette or default shortcuts (`Ctrl+Alt+N/P`, macOS `Cmd+Alt+N/P`).
  • Provide keybinding conflict help and starter templates for team-level shortcut overrides.
  • Provide localized UX (English/Korean) for commands, view labels, and webview text.

Not ready yet

  • Automated Marketplace publish pipeline is not established yet (manual publish flow).
  • Problems integration is baseline-level and still needs richer interaction polish beyond focus synchronization.
  • Release automation is still partial and Marketplace publish/docs sync remains mostly manual.

Verification commands

Open circuit view command pass
Command Palette > Ranvier: Open Circuit View
Refresh diagnostics command pass
Command Palette > Ranvier: Refresh Diagnostics
Issue navigation commands pass
Command Palette > Ranvier: Go To Next Node Issue / Ranvier: Go To Previous Node Issue

References

  • vscode/README.md
  • vscode/README.ko.md
If a check fails, verify the module setup and required input files, then rerun the same command.