# AGENTS.md

Persistent Context Across Sessions for Every Agent –  Captures everything your agent does during sessions, compresses it with AI, and injects relevant context back into future sessions. Works with Claude Code, OpenClaw, Codex, Gemini, Hermes, Copilot, OpenCode + More

## Setup

```
npm install
```

## Commands

```
npm run dev                      # run locally
npm run build                    # produce a build
npm run test                     # run the test suite, must pass before any commit
npm run typecheck                # type check without emitting
npm run build-and-sync
npm run sync-marketplace
npm run sync-marketplace:force
npm run build:binaries
```

## Layout

- `src/`      322 source files
- `tests/`    245 source files
- `scripts/`  28 source files
- `workers/`  26 source files
- `plugin/`   16 source files
- `openclaw/` 7 source files

## Conventions

- Tests live alongside the code they cover, following `cowork/PRO-ENDPOINT-SPEC.md`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `plugin/scripts/worker-service.cjs` is 2947KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.