Status
Submodule capabilities at a glance.
Check what each module can do now and how to verify it in one place.
ranvier
Core Rust module for first users to build typed decision flows, run canonical examples, and connect HTTP adapters.
Stage: Release-Ready
ranvier
Core Rust module for first users to build typed decision flows, run canonical examples, and connect HTTP adapters.
Versioning
0.51.00.51.xstablereleasedranvier/Cargo.toml [workspace.package.version]Artifacts
ranvier-core crates.io 0.51.0 releasedranvier-macros crates.io 0.51.0 releasedranvier-runtime crates.io 0.51.0 releasedranvier-http crates.io 0.51.0 releasedranvier-std crates.io 0.51.0 releasedranvier-guard crates.io 0.51.0 releasedranvier-audit crates.io 0.51.0 releasedranvier-compliance crates.io 0.51.0 releasedranvier-inspector crates.io 0.51.0 releasedranvier-openapi crates.io 0.51.0 releasedranvier-test crates.io 0.51.0 releasedranvier crates.io 0.51.0 releasedCan do now
- Build typed decision pipelines with Axon, Transition, Outcome, and Bus contracts, including explicit fault, branch, retry, timeout, panic-recovery, streaming outcomes, and explicitly shared read-only parallel context.
- Propagate structured cooperative cancellation through Axon, parallel and streaming execution, persistence and compensation, and managed HTTP, Inspector, and cluster lifecycles without changing domain Outcome.
- Expose selected decision workflows through native HTTP or hybrid Tower/Axum integration with typed JSON, query, path, pagination, and semantic-validation boundaries.
- Apply composable guards for authentication, CORS, security headers, request limits, idempotency, rate limiting, proxy trust, and other per-route policies.
- Publish contract-driven OpenAPI and Problem Details while serving static/SPA/template content and WebSocket or SSE endpoints when the application needs them.
- Observe and debug live decisions through Inspector metrics, traces, payload capture, dead letters, breakpoints, lineage, route metadata, relay, and schema-derived samples.
- Run resumable session and job workflows with persistence checkpoints, compensation, audit sinks, and explicit failure-recovery behavior.
- Operate services with configuration profiles, structured logging, TLS, Prometheus/OTLP telemetry, and deployment-controlled Inspector security.
- Test decision and HTTP behavior in process with AxonTestKit, Timeline, TestApp, and ranvier-test helpers, backed by repeatable performance baselines.
- Validate library and execution-structure compatibility with SemVer checks, versioned schemas, and schematic diff/policy artifacts.
- Learn and verify supported patterns through tiered examples and references covering APIs, real-time flows, sagas, policy enforcement, and LLM-as-Transition use cases.
Current limitations
- Cooperative cancellation does not preempt CPU-bound or blocking work that never yields, and forced process loss cannot guarantee compensation completion.
runtime - Distributed durability, identity, and telemetry guarantees require explicitly configured external services; in-memory development defaults are not production guarantees.
deployment - The M419-RQ10 single-host in-memory fixture is not a universal throughput or latency SLO for external services, other machines, WebSocket/SSE populations, or adopter code.
runtime
Product boundaries
- Token or claim mapping to Inspector roles and tenants is not a core-runtime identity provider; deployments must integrate their gateway or identity system.
deployment - Ranvier is not an ORM, general reverse proxy, or hosting platform; applications integrate dedicated ecosystem components at those edges.
application
Verification commands
node scripts/tiered_example_gate.mjs --lane developer --phase checkcargo run -p typed-state-treecargo run -p routing-params-democargo test -p ranvier-httpcargo test -p ranvier-http --test test_app_healthcargo test -p ranvier-http --features validationcargo run -p ranvier-http --example validation_struct_level --features validationcargo test -p ranvier-guard --features advancedcargo test -p ranvier-openapicargo check -p openapi-democargo test -p ranvier-httpcargo check -p static-spa-democargo test -p ranvier-httpcargo check -p websocket-ingress-democargo test -p ranvier-inspectornode scripts/tiered_example_gate.mjs --lane release --phase allnode scripts/tiered_example_gate.mjs --lane lab --phase all./scripts/m119_examples_smoke.ps1./scripts/m131_inspector_quickview_smoke.ps1./scripts/m131_schematic_diff_policy_smoke.ps1./scripts/m131_fullstack_embedded_smoke.ps1cargo test -p ranvier-runtime timeline_assertion_works_in_integration_testcargo run -p ecosystem-seaorm-democargo run -p ecosystem-diesel-democargo run -p ecosystem-redis-democargo run -p ecosystem-nats-democargo run -p ecosystem-meilisearch-democargo check -p session-patterncargo test -p ranvier-inspector metrics stallcargo test -p ranvier-inspector breakpoint payloadcargo check -p guard-democargo check -p guard-integration-democargo check -p auth-jwt-role-democargo test -p ranvier-core -p ranvier-runtime -p ranvier-http -p ranvier-inspector --all-featuresnode scripts/api_surface_inventory.mjs --check && node scripts/candidate_api_baseline.mjs --check && node scripts/candidate_compile_contract.mjsnode scripts/candidate_api_semver.mjsReferences
ranvier/README.md
cli
First-user command-line tool to inspect Ranvier command surface, scaffold projects interactively, and generate schematic/projection artifacts from examples.
Stage: Release-Ready
cli
First-user command-line tool to inspect Ranvier command surface, scaffold projects interactively, and generate schematic/projection artifacts from examples.
Versioning
0.8.00.8.xstablereleasedcli/Cargo.toml [package.version]Artifacts
ranvier-cli crates.io 0.8.0 releasedCan do now
- Discover the supported command surface and reject incompatible schematic schema versions before processing artifacts.
- Scaffold macro-first projects from curated API, worker, scheduler, saga, screening, pipeline, and domain templates with explicit dependency choices.
- Export schematic and trace-projection artifacts from workspaces, examples, and timeline inputs.
- Compare schematics across Git references and enforce versioned TOML structural policies with CI-friendly exit codes.
- Generate self-contained HTML status pages from schematic artifacts.
- Plan and apply explicit rule-based version migrations with dry-run, verbose, and JSON reporting modes.
- Browse, fetch, and verify example schematics from local or remote catalogs.
- Execute request collections headlessly with captures, environment interpolation, assertions, glob selection, and text, JSON, or JUnit output.
Current limitations
No active limitation items.
Product boundaries
- The CLI is not an interactive IDE or live multi-user monitoring surface; use the VS Code extension or Studio products for those workflows.
cli - Scaffolding and migration rules cannot infer arbitrary application business changes; generated or rewritten output still requires review.
cli
Verification commands
cargo run -- --helpcargo run -- schematic basic-schematic --output schematic.jsoncargo run -- schematic diff --helpcargo run -- schematic policy check --helpcargo run -- catalog list --local --jsoncargo run -- catalog fetch basic-schematic --local --output /tmp/basic.json && cargo run -- catalog verify /tmp/basic.jsonReferences
cli/README.md
studio
GPU-accelerated native desktop app (Bevy 0.18) for 3D schematic graph visualization, real-time edge data flow animation, payload inspection, interactive breakpoint debugging, and full production UX (settings, search, 21 keyboard shortcuts).
Stage: Frozen
studio
GPU-accelerated native desktop app (Bevy 0.18) for 3D schematic graph visualization, real-time edge data flow animation, payload inspection, interactive breakpoint debugging, and full production UX (settings, search, 21 keyboard shortcuts).
Versioning
0.2.00.2.xpreviewinternalstudio/Cargo.toml [package.version]Artifacts
ranvier-studio cargo 0.2.0 internalCan do now
- Render Guard, Transition, and Compensation layers as a GPU-accelerated 3D schematic.
- Navigate and search large decision graphs with multiple camera modes and focused node selection.
- Follow real-time node state and edge data-flow changes from Inspector WebSocket events.
- Inspect captured payload JSON when the target Inspector explicitly enables payload capture.
- Set breakpoints and pause, step, or resume decision execution from the desktop debugger.
- Inspect Bus, circuits, routes, dead letters, relay operations, and trace timelines in dedicated panels.
- Persist Inspector connection, authentication, refresh, and view preferences for repeated desktop sessions.
Current limitations
No active limitation items.
Product boundaries
- Studio is not the primary IDE surface for inline source navigation; that workflow belongs to the VS Code extension.
studio - Studio is a native desktop application and does not run in mobile or web browsers.
studio
Verification commands
cargo run -p ranvier-studio -- --url http://localhost:9090Send request to target service > Observe node state changes in StudioRight-click node > Set Breakpoint > Trigger > Step > ResumeReferences
studio/README.md
studio-server
Web monitoring dashboard server — Ranvier's first 'Built with Ranvier' reference application. Relays Inspector API calls via typed Axon pipelines and serves a SvelteKit static dashboard with SvelteFlow interactive schematic for browser-based team monitoring. Successor to Studio Desktop (Bevy, frozen at v0.2.0).
Stage: Active
studio-server
Web monitoring dashboard server — Ranvier's first 'Built with Ranvier' reference application. Relays Inspector API calls via typed Axon pipelines and serves a SvelteKit static dashboard with SvelteFlow interactive schematic for browser-based team monitoring. Successor to Studio Desktop (Bevy, frozen at v0.2.0).
Versioning
0.19.00.19.xpreviewinternalstudio-server/Cargo.toml [package.version]Artifacts
studio-server cargo 0.19.0 internalstudio-dashboard npm 0.1.0 internalCan do now
- Serve a browser-based team monitoring dashboard and relay Inspector APIs through Ranvier Axon pipelines.
- Summarize service health, throughput, latency, error, node, circuit, route, and dead-letter signals with configurable polling.
- Explore circuit topology in an interactive schematic with node details and breakpoint toggles.
- Filter and monitor Inspector lifecycle events with visible new-event feedback.
- Inspect trace timelines and distinguish active, slow, successful, and faulted execution segments.
- Review dead-letter payloads and request retry or discard actions.
- Build and deploy the dashboard and Rust relay together with the maintained container and Compose configuration.
Current limitations
- Studio Server uses HTTP polling rather than Inspector WebSocket live streaming.
studio-server
Product boundaries
- Studio Server does not provide the native Studio application's 3D GPU-accelerated visualization.
studio
Verification commands
cargo run -p studio-server > open http://localhost:9040curl http://localhost:9040/api/v1/metricscd frontend && npm run buildReferences
studio-server/README.md
vscode
First-user IDE companion extension for Ranvier development with VS Code-native circuit navigation, source jump, diagnostics overlays, issue navigation, accessible helper dialogs, and API request testing (HTTP/WebSocket/SSE).
Stage: Release-Ready
vscode
First-user IDE companion extension for Ranvier development with VS Code-native circuit navigation, source jump, diagnostics overlays, issue navigation, accessible helper dialogs, and API request testing (HTTP/WebSocket/SSE).
Versioning
0.4.00.4.xpreviewreleasedvscode/package.json [version]Artifacts
ranvier-vscode vscode-marketplace 0.4.0 releasedCan do now
- Render schematic graphs and navigate bidirectionally between mapped circuit nodes and Rust source locations.
- Project diagnostics into VS Code Problems and move through node-linked issues from the editor or command palette.
- Connect to Inspector for per-node heatmaps, lifecycle events, stalled-node alerts, and breakpoint-aware debugging.
- Discover, compose, send, inspect, save, and replay HTTP requests in a circuit-aware API Explorer with cached-schema fallback.
- Create schema-derived bodies, presets, environment variables, collections, and bounded request history for repeatable API work.
- Import or export requests with secret redaction and conflict handling, then run batches with schema checks, assertions, and JUnit summaries.
- Exercise HTTP, WebSocket, and SSE endpoints with protocol-appropriate connection, message, event, filter, and reconnection views.
- Distinguish streaming transitions and data-flow edges from ordinary pipeline nodes in the schematic.
- Insert curated Rust and complex-workflow snippets, browse example schematics, and run learning examples from the integrated terminal.
- Use the Circuit, Toolbox, Feature, and API tools through one accessible EN/KO sidebar with command-palette entry points and team keybinding templates.
Current limitations
- Live metrics and debug control require a reachable, authorized Inspector; offline behavior is limited to cached or static artifacts.
deployment
Product boundaries
- The extension does not replace the Rust compiler or CLI; schematic and diagnostic artifacts still come from project tooling.
vscode - The extension is a developer IDE companion, not a multi-user production monitoring surface; use Studio Server for team monitoring.
studio-server
Verification commands
Command Palette > Ranvier: Open Circuit ViewCommand Palette > Ranvier: Refresh DiagnosticsCommand Palette > Ranvier: Go To Next Node Issue / Ranvier: Go To Previous Node IssueConnect to Inspector server > Toggle heatmap modes in Circuit ViewCircuit View > Events panel > Filter by node/type/textStall threshold exceeded > Node shows pulsing glowReferences
vscode/README.mdvscode/README.ko.md