reeval 0.6.3 → 0.7.0

package/README.md

@@ -0,0 +1,265 @@
+# reeval
+
+**Find out whether your skill, docs or MCP server makes coding agents better, on real agents.**
+
+```ts
+// evals/api.eval.ts, from examples/hello
+import { defineEnvironment, evaluate, expect } from 'reeval'
+import { claudeCode, codex, cursor } from 'reeval/harness'
+import { appFiles, probeUsers } from './api/app.ts'
+
+// create-next-app's API template at a tag. No baseline, so it's the control.
+const nextApi = defineEnvironment('nextjs-api', ({ git }) => ({
+  workspace: git('github:vercel/next.js', {
+    ref: 'v16.3.7',
+    path: 'packages/create-next-app/templates/app-api/ts',
+  }),
+  files: appFiles, // package.json, and lib/users.ts to list
+  setup: ['mv gitignore .gitignore', 'npm install --no-audit --no-fund'],
+}))
+
+const withSkill = nextApi.extendEnvironment('with-api-conventions', ({ skill }) => ({
+  skills: [
+    skill.git('github:invertase/reeval', {
+      ref: '052108cae3ca4c9d1bad1e6b527d76bdf11fd4cc',
+      path: 'examples/hello/skills',
+      only: ['api-conventions'],
+    }),
+  ],
+}))
+
+evaluate(
+  'how well the api-conventions skill influences the output',
+  {
+    environment: nextApi,
+    harness: [
+      cursor({ model: 'composer-2.5' }),
+      claudeCode({ model: 'claude-sonnet-5' }),
+      codex({ model: 'gpt-5.6-luna' }),
+    ],
+    runs: 3,
+    timeout: '20m',
+    compare: {
+      variants: [withSkill],
+      questions: ['Which endpoint follows our API conventions?'],
+    },
+  },
+  async (c) => {
+    await c.send(
+      'Add a paginated GET /api/users endpoint (app/api/users/route.ts) ' +
+        'over lib/users.ts, with tests that npm test runs.',
+    )
+    // The route exists and pages by cursor.
+    await expect(c).toHaveFile('app/api/users/route.ts', /cursor/i)
+    // It builds, types included.
+    await expect(c.exec('npm run build')).toSucceed()
+    // The agent's own tests pass.
+    await expect(c.exec('npm test')).toSucceed()
+    // The built route pages as { data, nextCursor } and rejects a bad cursor.
+    await expect(c.exec(probeUsers)).toSucceed()
+    // A judge for what the checks can't read: do the tests cover it?
+    const covered = 'Do the tests follow nextCursor to the end and check invalid_cursor?'
+    expect(await c.judge(covered)).toPass()
+  },
+)
+```
+
+- **Real agents in sandboxes.** Cursor, Claude Code, Codex, Antigravity, OpenCode, Goose and pi
+  each work in a fresh local Docker container. Their API keys stay on the host: the sandbox gets
+  a placeholder, and reeval's egress gateway swaps in the key only on requests to that provider.
+- **Any environment.** Start from a git repository at a pinned ref, then add files, setup steps,
+  rules, skills, MCP servers and secrets, on reeval's image or your own `from` or Dockerfile.
+- **The whole matrix.** Each harness × environment is a cell with its own runs, all planned
+  before anything starts (`reeval run --dry-run`), with profiles that size a run for a PR or a
+  nightly.
+- **Checks and judges.** Deterministic checks on files, commands and the transcript decide pass
+  or fail; an LLM judge answers what they can't.
+- **Compare, questions and analysis.** `compare` reports each variant's lift over the control,
+  with a 95% interval and its effort; `questions` asks a model which attempt did better, pair by
+  pair and blind; `reeval analyze` writes a checked reading of a run.
+- **Results in your repo.** Every run is a JSON record you can commit, diff with `reeval compare`,
+  query with SQL (`reeval query`) and browse in `reeval studio`.
+
+A real run of the eval, one attempt per cell: no control paged by cursor, and with the skill
+all three agents passed every check.
+
+```text
+$ reeval run evals/api.eval.ts --runs 1
+…
+   ✓ how well the api-conventions skill influences the output      3/6 · 100% gated  6 attempts
+       cursor:composer-2.5/nextjs-api/docker                    control    0/1    0%   not gated
+       cursor:composer-2.5/with-api-conventions/docker          variant    1/1  100%   lift +100 pts (95% −12…+100, 1/1 vs 0/1), within noise
+       claude-code:claude-sonnet-5/nextjs-api/docker            control    0/1    0%   not gated
+       claude-code:claude-sonnet-5/with-api-conventions/docker  variant    1/1  100%   lift +100 pts (95% −12…+100, 1/1 vs 0/1), within noise
+       codex:gpt-5.6-luna/nextjs-api/docker                     control    0/1    0%   not gated
+       codex:gpt-5.6-luna/with-api-conventions/docker           variant    1/1  100%   lift +100 pts (95% −12…+100, 1/1 vs 0/1), within noise
+       question  "Which endpoint follows our API conventions?" across: claude-code:claude-sonnet-5 2/4 (50%), codex:gpt-5.6-luna 0/4 (0%), cursor:composer-2.5 4/4 (100%) · 6 votes, 0 ties · gemini-3.8-flash
+…
+```
+
+```bash
+npm i -D reeval   # the CLI is `reeval`, or `re` for short
+```
+
+You need Node 22.13 or later and, for real runs, a running Docker.
+
+| Platform | Fake agent and sandbox | Real runs (Docker sandbox) |
+|---|---|---|
+| Linux | ✓ | ✓ Docker Engine or Docker Desktop |
+| macOS | ✓ | ✓ Docker Desktop, OrbStack or Colima |
+| Windows | ✓ with [Git for Windows](https://git-scm.com/download/win) (its `sh`) | ✓ Docker Desktop on the WSL 2 backend, running Linux containers |
+
+`reeval doctor` checks Docker for your platform and names the fix. CI runs every tier on Linux and
+everything but the Docker tier on Windows and macOS.
+
+## A minimal eval
+
+```ts
+// evals/hello.eval.ts
+import { evaluate, expect, group } from 'reeval'
+
+group('greet module', () => {
+  evaluate('creates a tested greet module', async (c) => {
+    const turn = await c.send(
+      'Create greet.js exporting greet(name) that returns "Hello, <name>!", ' +
+        'and greet.test.js that tests it with node:test. No dependencies.',
+    )
+
+    await expect(turn).toHaveFile('greet.js')
+    await expect(c.exec('node --test')).toSucceed()
+    expect(await c.judge("Does the agent's final message accurately describe what it changed?")).toPass()
+  })
+})
+```
+
+```ts
+// reeval.config.ts
+import { defineConfig } from 'reeval'
+import { cursor } from 'reeval/harness'
+
+export default defineConfig({
+  include: ['evals/**/*.eval.ts'],
+  harness: cursor({ model: 'composer-2.5' }), // or claudeCode({ model }), antigravity({ model }), opencode({ model }), goose({ model }), pi({ model }), codex({ model }), or a list: each is its own cell
+  judge: { model: 'typesafe-ai/jev-1.13.0', threshold: 0.8 }, // optional; pin the version
+  timeout: '15m',
+  profiles: {
+    pr: { limit: { runs: 1, compare: false }, budget: { attempts: 20 } },
+    nightly: { defaults: { runs: 3 }, record: 'always' },
+  },
+  defaultProfile: { ci: 'pr' },
+})
+```
+
+## Compare with a skill
+
+Give the agent a skill and check that it helps. `plain` is the baseline. The variant is
+that environment plus the skill, and compare runs the two apart, with the same prompt and
+the same checks:
+
+```ts
+// evals/skill.eval.ts (trimmed from examples/hello)
+import { defineEnvironment, evaluate, expect, group } from 'reeval'
+
+const plain = defineEnvironment('plain', {})
+const withHouseGreeting = plain.extendEnvironment(
+  'with-house-greeting',
+  ({ skill }) => ({
+    skills: [skill.local('../skills/house-greeting')],
+  }),
+)
+
+group(
+  'house greeting',
+  { compare: { baseline: plain, variants: [withHouseGreeting] } },
+  () => {
+    evaluate('greets in the house style', async (c) => {
+      await c.send(
+        'Create greet.js exporting greet(name) that greets the person ' +
+          'in our house style.',
+      )
+      await expect(c.exec(greetAda)).toSucceed() // passes only for "Ahoy, Ada!"
+    })
+  },
+)
+```
+
+```text
+$ reeval run skill --runs 2
+plan  1 eval · 2 cells · 4 attempts · ~50s serial (~13s at concurrency 4)
+…
+     ✓ greets in the house style      2/4 · 100% gated  4 attempts
+         cursor:composer-2.5/plain/docker                control    0/2    0%   not gated
+         cursor:composer-2.5/with-house-greeting/docker  variant    2/2  100%   lift +100 pts (95% +7…+100, 2/2 vs 0/2)
+           effort: tools 3 vs 8 (×0.38), agent 9s vs 18s (×0.50): too few attempts to test
+```
+
+## Run it
+
+```text
+$ CI=1 reeval run greet
+plan  profile pr (auto: CI is set) · 2 evals · 2 cells · 2 attempts · ~40s serial (~20s at concurrency 4) · budget 20 attempts ✓
+reeval 0.0.1 · 3 eval files · harness cursor:composer-2.5 · sandbox docker · concurrency 4 · grouped logs
+[creates#1 cursor] ▶ evals/hello.eval.ts › greet module › creates a tested greet module
+[creates#1 cursor] ✓ evals/hello.eval.ts › greet module › creates a tested greet module  17s
+[creates#1 cursor]  +0:00 sandbox ready 1s
+[creates#1 cursor]  +0:01 turn 1 done 12s · 1 tool call, 2 file edits
+[creates#1 cursor]  +0:13 $ node --test  exit 0 129ms
+[creates#1 cursor]  +0:13 judge  pass 1.00 (≥ 0.8)  Does the agent's final message accurately describe what it changed?
+[adds#1 cursor] ▶ evals/hello.eval.ts › greet module › adds a default name in a follow-up turn
+[adds#1 cursor] ✓ evals/hello.eval.ts › greet module › adds a default name in a follow-up turn  23s
+…
+
+Summary
+ evals/hello.eval.ts
+   greet module
+     ✓ creates a tested greet module                17s  judge 1.00  1 turn
+     ✓ adds a default name in a follow-up turn      23s  judge 1.00  2 turns
+
+   Evals  2 passed (2)
+Duration  40s
+ Results  .reeval/runs/20260924T213759Z_1ba71aa_ci_4vb0/summary.md
+```
+
+Under a coding agent, reeval switches to compact output: one block per failure and the path to its
+record. To see what an attempt did step by step, add `-v`: a timestamped line per phase (image,
+container, setup, brokering, each tool call, checks, judge calls, every gateway request).
+`-vv` adds the raw payloads and every `docker` command. Either way each attempt's trace is
+kept locally in `.reeval/debug`, never in the committed history. Commit runs into `evals/.history/` with `reeval record`, then track them with `reeval history`
+and `reeval compare`, or ask across runs with SQL: `reeval query lift`, `reeval query effort` (tool calls and
+agent time, variant against control), `reeval query factor_effects`, or
+`reeval query "SELECT * FROM failing_attempts WHERE skill = 'house-greeting'"`. Where the harness
+reports them (Cursor, Claude Code, Antigravity, pi and Codex do), the record keeps each turn's tokens and the model that
+served it, and totals them per attempt and per run.
+
+`reeval analyze` explains a run: one LLM call over a digest of those facts, with every claim's
+citations and every suggested command checked against reeval's own CLI. It's cached in `.reeval/`;
+`--save` commits it next to the run, and `reeval analyze --context` hands the same digest to your own
+coding agent instead, with no key.
+
+## Studio
+
+```bash
+reeval studio                    # browse runs, evals and transcripts at http://127.0.0.1:4984
+reeval studio build --out site   # the same thing as a static site for GitHub Pages or any host
+```
+
+The studio shows each run's commit, pass counts and drift. For compares it shows per-cell pass
+rates, lift and effort, and a run's saved analyses in its Analysis tab, and for each attempt the transcript, diff, checks and judge input. `reeval studio`
+adds a Debug tab for attempts with local debug data.
+
+## Learn more
+
+The user docs in [`docs/`](./docs) are a [docs.page](https://use.docs.page) site: a Guide from a
+first eval to CI, Concepts, Recipes, and a Reference tab with every option, command, flag, exit
+code and file format. Preview them with `npx @docs.page/cli preview`. Coding agents writing evals
+can load the reeval skill in [`.agents/skills/reeval/SKILL.md`](./.agents/skills/reeval/SKILL.md).
+[AGENTS.md](./AGENTS.md) covers developing this repo.
+
+## License
+
+Licensed under the [Apache License, Version 2.0](./LICENSE). Copyright 2026 Invertase Limited.
+Questions about licensing: [oss@invertase.io](mailto:oss@invertase.io).
+
+The published package inlines some third-party code (the studio app's React, Radix UI and
+shadcn/ui components, and Claude Code's patched adapter). Its `THIRD_PARTY_NOTICES.md`, generated
+at build time, lists each of those packages with its version, licence and notices.

package/THIRD_PARTY_NOTICES.md

@@ -7,8 +7,8 @@ with its own licence.
 
 | Package | Version | Licence | Inlined into |
 |---|---|---|---|
-| @ai-sdk/harness | 1.0.144 | Apache-2.0 | dist/bridge |
-| @ai-sdk/harness-claude-code | 1.0.148 | Apache-2.0 | dist, dist/bridge |
+| @ai-sdk/harness | 1.0.148 | Apache-2.0 | dist/bridge |
+| @ai-sdk/harness-claude-code | 1.0.152 | Apache-2.0 | dist, dist/bridge |
 | @floating-ui/core | 1.8.0 | MIT | dist/studio-app |
 | @floating-ui/dom | 1.8.0 | MIT | dist/studio-app |
 | @floating-ui/react-dom | 2.1.9 | MIT | dist/studio-app |
@@ -72,7 +72,7 @@ with its own licence.
 | use-sync-external-store | 1.7.0 | MIT | dist/studio-app |
 | shadcn/ui | | MIT | 16 source files |
 
-## @ai-sdk/harness@1.0.144
+## @ai-sdk/harness@1.0.148
 
 - Licence: Apache-2.0
 - Source: https://github.com/vercel/ai
@@ -94,12 +94,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ```
 
-## @ai-sdk/harness-claude-code@1.0.148
+## @ai-sdk/harness-claude-code@1.0.152
 
 - Licence: Apache-2.0
 - Source: https://github.com/vercel/ai
 - Inlined into: dist, dist/bridge
-- Modified: dist/bridge/index.mjs, with patches/@ai-sdk__harness-claude-code@1.0.148.patch
+- Modified: dist/bridge/index.mjs, with patches/@ai-sdk__harness-claude-code@1.0.152.patch
 
 ```text
 Copyright 2023 Vercel, Inc.

package/assets/package.json

@@ -4,6 +4,6 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@earendil-works/pi-coding-agent": "1.1.0"
+    "@earendil-works/pi-coding-agent": "1.2.0"
   }
 }