Nerve Protocol v1 reference
This directory documents the implemented Nerve Protocol v1. The wire envelopes, event catalog, and operation catalog in packages/contracts/src/wire/, packages/contracts/src/events/, and packages/contracts/src/operations/, together with the sessions in packages/protocol/, are authoritative.
Protocol v1 connects the workbench app (ui) with the server (workbench_server). The schema also reserves desktop_shell and cli wire roles for catalog targeting and future clients, but the current desktop shell manages daemon lifecycle outside the Protocol v1 session and no CLI client is implemented.
The link uses a strict envelope, catalog-validated RPC, subscription-based stream recovery, unsequenced notifications, snapshots, and bounded delivery behavior. HTTP and WebSocket requests share the same operation catalog.
Contents
Section titled “Contents”- Overview
- Envelope
- Session lifecycle
- Events, subscriptions and recovery, and backpressure
- HTTP mapping
- Errors and security
- Extensions
- Examples
- Implementation guide, status, and coverage
The operation and event catalogs are exported by @nervekit/contracts; applications must not invent method aliases, event types, delivery classes, or stream routing.