Skip to content

Commit 6fe7a94

Browse files
committed
docs(agents): point infrastructure at interchange first
1 parent 76fee53 commit 6fe7a94

1 file changed

Lines changed: 59 additions & 11 deletions

File tree

‎AGENTS.md‎

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,65 @@ It authenticates over HTTPS via `gh`'s credential helper and rewrites the SSH re
8787

8888
## Building on Interchange
8989

90-
Interchange is the standard library for this repo. Every `@intx/*` package this repo imports resolves to vendored source under `vendor/intx-*` at a single pinned upstream commit — the sole exception is `@intx/tools-lsp`, which remains on published npm (provenance, patch ledgers, and the re-sync procedure: `docs/VENDORING.md`). We never modify or push to the upstream interchange repository. Before writing any new infrastructure — plugins, middleware, utilities, state management, logging, authz, inference, tools — check these packages.
91-
92-
| Package | Covers |
93-
| ---------------------- | --------------------------------------------------------------------------------------------------------------------- |
94-
| `@intx/authz` | Grant matching (`matchPattern`, `evaluateGrants`) for permission approvals; Corbits owns the gate, store, and TUI ask |
95-
| `@intx/inference` | Reactor loop, `createAuthzExtension`, `DefaultDirector` |
96-
| `@intx/agent` | Agent lifecycle, send queue, stream |
97-
| `@intx/tools-posix` | Shell, file read/write/edit, grep, search |
98-
| `@intx/storage-isogit` | Git-backed state persistence |
99-
| `@intx/log` | Structured logging via LogTape |
100-
| `@intx/types` | All shared runtime types |
90+
Interchange is the standard library for this repo. Before writing plugins,
91+
middleware, state, logging, authz, inference, tools, mail, fleet, or
92+
workflows, read Interchange first — do not invent a Corbits parallel.
93+
94+
Read, in this order:
95+
96+
- Upstream layout and package READMEs:
97+
https://github.com/faremeter/interchange (`LAYOUT.md`, then the package
98+
you are about to touch)
99+
- Vendored source under `vendor/intx-*` when this repo still vendors that
100+
package
101+
- Skills: `interchange`, `interchange-agents`, `interchange-workflows`,
102+
`interchange-run-modes`
103+
- Upstream examples: `agent-quickstart`, `coding-agent`, `ring-demo`
104+
(multi-agent mail)
105+
106+
### Do not reimplement
107+
108+
These already exist. Use them; do not write a second copy.
109+
110+
- Harness INBOX / `deliver`
111+
- `@intx/mailbox` IMAP
112+
- FleetMailbox / occupancy
113+
- `src/workflows` coordinators
114+
- Grant matching
115+
- `PendingOperation` ask-park
116+
117+
If Interchange is missing something you need, stop and ask the operator. Do
118+
not invent a Corbits-owned mail, fleet, workflow, authz, or park layer
119+
beside it.
120+
121+
### Vendor policy
122+
123+
- Unused and unpatched: delete the vendor tree. Do not keep dead trees.
124+
- Used and unpatched: install from npm.
125+
- Used and patched (`inference`, `types`, `storage-isogit`, `agent`): stay
126+
vendored; see `docs/VENDORING.md`.
127+
- We never modify or push to `faremeter/interchange`.
128+
129+
Provenance, patch ledgers, and the re-sync procedure live in
130+
`docs/VENDORING.md`.
131+
132+
### Packages
133+
134+
| Package | Covers |
135+
| ---------------------- | -------------------------------------------------------------------------- |
136+
| `@intx/agent` | `createAgent`, `send`, `stream`, `deliver` |
137+
| `@intx/harness` | INBOX watch, mail tools (npm when we use it; do not vendor an unused copy) |
138+
| `@intx/authz` | `evaluateGrants`, `GrantStore`, ask effect |
139+
| `@intx/inference` | Reactor, `createAuthzExtension`, `DefaultDirector`, compactors registry |
140+
| `@intx/tools-posix` | Shell, file read/write/edit, grep, search |
141+
| `@intx/storage-isogit` | Git-backed state persistence |
142+
| `@intx/log` | Structured logging via LogTape |
143+
| `@intx/types` | All shared runtime types |
144+
| `@intx/workflow` | `defineWorkflow`, `runLocal` (npm when we use it) |
145+
146+
Corbits owns TUI/exec chrome, auto-shell / secret-guard / path-sandbox
147+
_policy_, director cards, and MCP (until decided otherwise). Corbits does
148+
not own a second mail, fleet, or workflow OS.
101149

102150
## Reference
103151

0 commit comments

Comments
 (0)