c4289b20eb
A wrapper baked its path at creation, so a reference held across a structural mutation kept addressing its old index: unshift then a write through a held element edited its neighbour, and a write after a splice could produce a path the replica cannot resolve. The baseline diff this tracker replaced was immune, because its dirty paths were only hints and the ops came from comparing values. A wrapper now holds a cell (parent link plus segment) and the path is walked at use time, so renumbering an element corrects every descendant. pop/shift/unshift/splice and length truncation shift live children by the delta and mark removed ones dead; sort/reverse/fill/copyWithin relocate them by identity. Renumbering iterates a set of live cells rather than the lookup cache, which is keyed by index and can evict a child that is still held. Writes through an element that left the document mutate it and record nothing, as plain JS and the baseline diff both do. One object can occupy several positions in the tree. A wrapper is now shared per target and holds a cell per position, and a write emits an op for each, which is what the baseline diff produced for the same shape. Positions are registered when a path is read, when a tracked value is assigned elsewhere, and when one is inserted by an array mutator (only the inserted range is examined; scanning the array made every structural mutation O(n)). A blocked view of an object gets its own wrapper so the reserved-key guard cannot be bypassed through a safe alias. Paths are cached per cell against a counter that only structural mutation bumps, and the per-write cell walk is skipped until a document actually aliases something. |
||
|---|---|---|
| .github | ||
| .husky | ||
| .pi | ||
| packages | ||
| scripts | ||
| .gitattributes | ||
| .gitignore | ||
| .npmrc | ||
| AGENTS.md | ||
| biome.json | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| mini-test.sh | ||
| package-lock.json | ||
| package.json | ||
| pi-test.bat | ||
| pi-test.ps1 | ||
| pi-test.sh | ||
| README.md | ||
| SECURITY.md | ||
| test.sh | ||
| tsconfig.base.json | ||
| tsconfig.json | ||
| tui-plan.md | ||
| vitest.base.ts | ||
New issues and PRs from new contributors are auto-closed by default. Maintainers review auto-closed issues daily. See CONTRIBUTING.md.
Pi Agent Harness
This is the home of the Pi agent harness project including our self extensible coding agent.
- @earendil-works/pi-coding-agent: Interactive coding agent CLI
- @earendil-works/pi-agent-core: Agent runtime with tool calling and state management
- @earendil-works/pi-ai: Unified multi-provider LLM API (OpenAI, Anthropic, Google, …)
To learn more about Pi:
- Visit pi.dev, the project website with demos
- Read the documentation, but you can also ask the agent to explain itself
All Packages
| Package | Description |
|---|---|
| @earendil-works/chord | Standalone application-composition runtime for services, replicated state, RPC, and plugins |
| @earendil-works/pi-telemetry | Vendor-neutral telemetry contracts, reference adapter, conformance tests, and typed schemas |
| @earendil-works/pi-ai | Unified multi-provider LLM API (OpenAI, Anthropic, Google, etc.) |
| @earendil-works/pi-agent-core | Agent runtime with tool calling and state management |
| @earendil-works/pi-coding-agent | Interactive coding agent CLI |
| @earendil-works/pi-tui | Terminal UI library with differential rendering |
For Slack/chat automation and workflows see earendil-works/pi-chat.
Permissions & Containerization
Pi does not include a built-in permission system for restricting filesystem, process, network, or credential access. By default, it runs with the permissions of the user and process that launched it.
If you need stronger boundaries, containerize or sandbox Pi. See packages/coding-agent/docs/containerization.md for three patterns:
- Gondolin extension: keep
piand provider auth on the host while routing built-in tools and!commands into a local Linux micro-VM. - Plain Docker: run the whole
piprocess in a local container for simple isolation. - OpenShell: run the whole
piprocess in a policy-controlled sandbox.
Contributing
See CONTRIBUTING.md for contribution guidelines and AGENTS.md for project-specific rules (for both humans and agents). Longer term plans for Pi can also be found in RFCs.
Development
npm install --ignore-scripts # Install all dependencies without running lifecycle scripts
npm run build # Refresh model data, then build all packages
npm run build:offline # Rebuild using existing model data without network access
npm run check # Lint, format, and type check
./test.sh # Run tests (skips LLM-dependent tests without API keys)
./pi-test.sh # Run pi from sources (can be run from any directory)
Building standalone binaries from release source
GitHub releases include a versioned source archive covered by the release's SHA256SUMS file. Extract it and run the same build script used for the official standalone binaries:
VERSION="<release-version>"
tar -xzf "pi-${VERSION}-source.tar.gz"
cd "pi-${VERSION}"
./scripts/build-binaries.sh --offline-model-data --platform linux-x64 --out "$PWD/out"
The archive includes release model data and native prebuilds. --offline-model-data uses that model data without refreshing provider catalogs. The script installs dependencies and builds the executable with its runtime assets; pass --skip-install if dependencies are already provided.
Supply-chain hardening
We treat npm dependency changes as reviewed code changes.
- Direct external dependencies are pinned to exact versions. Internal workspace packages remain version-ranged.
.npmrcsetssave-exact=trueandmin-release-age=2to avoid same-day dependency releases during npm resolution.package-lock.jsonis the dependency ground truth. Pre-commit blocks accidental lockfile commits unlessPI_ALLOW_LOCKFILE_CHANGE=1is set.npm run checkverifies pinned direct deps, native TypeScript import compatibility, and the generated coding-agent shrinkwrap.- The published CLI package includes
packages/coding-agent/npm-shrinkwrap.json, generated from the root lockfile, to pin transitive deps for npm users. - Release smoke tests use
npm run release:localto build, pack, and create isolated npm and Bun installs outside the repo before tagging a release. - Local release installs, documented npm installs, and
pi update --selfuse--ignore-scriptswhere supported. - CI installs with
npm ci --ignore-scripts, and a scheduled GitHub workflow runsnpm audit --omit=devplusnpm audit signatures --omit=dev. - Shrinkwrap generation has an explicit allowlist for dependency lifecycle scripts; new lifecycle-script deps fail checks until reviewed.
Share your OSS coding agent sessions
If you use Pi or other coding agents for open source work, please share your sessions.
Public OSS session data helps improve coding agents with real-world tasks, tool use, failures, and fixes instead of toy benchmarks.
For the full explanation, see this post on X.
To publish sessions, use badlogic/pi-share-hf. Read its README.md for setup instructions. All you need is a Hugging Face account, the Hugging Face CLI, and pi-share-hf.
You can also watch this video, where I show how I publish my pi-mono sessions.
I regularly publish my own pi-mono work sessions here:
License
MIT
