sorrel/docs
Documentation
Sorrel is an agent-native version-control system: a content-addressed engine, a persistent local CLI, a Core-owned permission spine, portable workflows and secrets, and a collaboration Hub. These pages go one level deeper than the landing page; the generated API reference goes all the way down.
Engine
Sorrel Core
Objects, snapshots, changes, lanes, the merge and conflict model, and the policy/authority spine.
Local workflow
The sorrel CLI
A persistent local VCS: init, status, change, diff, log, lanes, three-way merge, and sync.
Collaboration
Sorrel Hub
The JSON API server, the browser interface, and the object/ref sync transport with persistent storage.
Execution
Workflows, Vault, Slices
Portable job bundles, sorrel.workflow.yml, secrets as references with redaction, and slice manifests.
Generated from code
API reference
Rustdoc for the engine, generated from the doc comments in the source. Always as current as the code.
Background
Architecture report
The full design document: product thesis, layered architecture, naming, and the long-term plan.
How the pieces fit
Everything builds on Sorrel Core, the Rust engine. The CLI embeds it directly for a persistent local workflow. The Hub speaks the sync transport over HTTP to move the same content-addressed objects between machines. Runners and Vault execute work and resolve secrets under Core policy decisions — no component invents its own permission model.
| Repository | Role |
|---|---|
sorrel-protocol | Canonical JSON schemas, examples, and the policy-conformance manifest every consumer tests against. |
sorrel-core | Rust engine: object store, snapshots, changes, lanes, merge model, policy and authority spine. |
sorrel-cli | The sorrel command: a persistent local VCS over the engine. |
sorrel-vault | Secrets and environment spec, local backend, and dev CLI. |
sorrel-runners | Portable workflow runners and the sorrel.workflow.yml parser. |
sorrel-slices | Slice (subproject) manifest generator for TS/JS codebases. |
sorrel-hub | Collaboration API server (JSON over HTTP, no UI). |
sorrel-hub-web | Browser frontend for the Hub API. |