Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.05 KB

File metadata and controls

57 lines (41 loc) · 2.05 KB

CLAUDE.md

Project orientation for Claude Code sessions working in this repo.

What this is

over/ACP — a small framework for running LLM agents on remote compute behind a single multiplexed WebSocket tunnel. Extracted from Overfolder. The high-level design and milestone roadmap live in SPEC.md; current status is in STATUS.md; concrete next steps in TODO.md.

Design docs

Authoritative subsystem specs live under docs/design/. Always read the relevant design doc before changing code in the matching crate.

If the doc and the code disagree, the doc is wrong — update it as part of the same change.

Workspace layout

Authoritative state lives in STATUS.md. Landed crates:

  • server/overacp-server, the stateless message broker. JWT-gated WebSocket tunnel + REST adapters + four operator hooks (BootProvider, ToolHost, QuotaPolicy, Authenticator).
  • compute/overacp-compute-core, a standalone library that exposes the ComputeProvider trait for operators who want a ready-made compute abstraction. Not used by the broker itself.
  • agent/overacp-agent, currently the boot-config surface; WS supervisor and stdio bridge are planned follow-ups.
  • loop/overloop, the reference child agent (vendored). Speaks over/ACP on stdio.

Planned crates per the SPEC roadmap:

  • protocol/overacp-protocol, pure wire types (no I/O).

Check STATUS.md before assuming a crate exists.

House rules (enforced by clippy)

  • absolute-paths-max-segments = 2 — bring paths into scope with use rather than writing 3-segment call sites.
  • too-many-lines-threshold = 500 — keep functions under 500 lines.
  • module_inception denied.

These are workspace-level lints; new crates inherit them via [lints] workspace = true.