Skip to content

README.md

Latest commit

 

History

History
46 lines (36 loc) · 1.78 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.78 KB

ARCP Rust SDK documentation

Reference docs for the Rust arcp crate. The top-level README is the front door; these pages go deeper into each subsystem and map back to the ARCP v1.1 specification.

ARCP Rust SDK architecture

Start here

  • Getting started - install, build a runtime + client, run the examples.
  • Architecture - how the single arcp crate is organized.
  • Transports - WebSocket, stdio, in-memory; when to pick each.
  • CLI - the arcp binary shipped by the crate.

Guides (one per spec section)

Page Spec
Sessions §6
Resume §6.3
Authentication §6.1
Jobs §7
Job events §8
Leases §9
Delegation §10
Observability §11
Errors §12
Vendor extensions §15

Reference

  • Recipes - copy-paste solutions to common Rust SDK tasks.
  • Conformance - spec coverage by section.
  • Troubleshooting - error codes, build issues, and runtime failure modes.

Diagrams

The architecture diagram is generated from Graphviz. Sources and rendering instructions live in diagrams/README.md; light and dark variants render through GitHub's <picture> element with prefers-color-scheme.