Skip to content

zksecurity/pi-mono

 
 

Repository files navigation

pi logo

Discord npm

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.

To learn more about Pi:

All Packages

Package Description
@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 pi and provider auth on the host while routing built-in tools and ! commands into a local Linux micro-VM.
  • Plain Docker: run the whole pi process in a local container for simple isolation.
  • OpenShell: run the whole pi process 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        # Build all packages
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)

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.
  • .npmrc sets save-exact=true and min-release-age=2 to avoid same-day dependency releases during npm resolution.
  • package-lock.json is the dependency ground truth. Pre-commit blocks accidental lockfile commits unless PI_ALLOW_LOCKFILE_CHANGE=1 is set.
  • npm run check verifies 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:local to 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 --self use --ignore-scripts where supported.
  • CI installs with npm ci --ignore-scripts, and a scheduled GitHub workflow runs npm audit --omit=dev plus npm 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:

zkao fork maintenance

This is a fork. zkao is our long-lived working branch and is periodically rebased onto main (upstream releases). Before each rebase we snapshot zkao into a backup branch named zkao-v<version>-backup, where <version> is the upstream release zkao was synced to at that time. See AGENTS.md for the full procedure.

Backup branch Synced version Date Notes
zkao-v0.75.5-backup v0.75.5 2026-05-28 Snapshot before rebasing onto main (v0.77.0); web search support + zkao CI/release workflows
zkao-v0.77.0-backup v0.77.0 2026-06-06 Snapshot before rebasing onto main (v0.78.1); Gemini web-search × function-calling combination fix
zkao-v0.78.1-backup v0.78.1 2026-06-09 Snapshot before rebasing onto main (v0.79.0); client/provider tool-name collision fix, Codex SSE read-timeout fix, Gemini web-search tool conversion tests
zkao-v0.79.0-backup v0.79.0 2026-06-12 Snapshot before rebasing onto main (v0.79.1); preserves our Claude Fable 5 support commit, dropped during the rebase in favor of upstream's own Fable 5 metadata
zkao-v0.79.1-backup v0.79.1 2026-06-20 Snapshot before rebasing onto main (v0.79.8); dropped our cherry-picked Fable 5 adaptive-thinking test commit (superseded upstream), re-resolved web-search vs. refusal-detail conflicts
zkao-v0.79.8-backup v0.79.8 2026-06-29 Snapshot before rebasing onto main (v0.80.2); re-ported every fork commit onto the upstream Models-runtime refactor, which moved provider stream/convert logic from providers/*.ts into api/*.ts

License

MIT

pi.dev domain graciously donated by

Exy mascot
exe.dev

About

AI agent toolkit: coding agent CLI, unified LLM API, TUI & web UI libraries, Slack bot, vLLM pods

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 93.5%
  • JavaScript 5.8%
  • CSS 0.3%
  • Shell 0.3%
  • C 0.1%
  • HTML 0.0%