ContextQMD
Back to Pi Mono

Pi Agent Harness Mono Repo

README.md

0.75.44.5 KB
Original Source
<p align="center"> <a href="https://pi.dev"> </a> </p> <p align="center"> <a href="https://discord.com/invite/3cU7Bz4UPx"></a> </p> <p align="center"> <a href="https://pi.dev">pi.dev</a> domain graciously donated by <a href="https://exe.dev"> exe.dev</a> </p>

New issues and PRs from new contributors are auto-closed by default. Maintainers review auto-closed issues daily. See CONTRIBUTING.md.

Pi Agent Harness Mono Repo

This is the home of the pi agent harness project including our self extensible coding agent.

To learn more about pi:

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:

All Packages

PackageDescription
@earendil-works/pi-aiUnified multi-provider LLM API (OpenAI, Anthropic, Google, etc.)
@earendil-works/pi-agent-coreAgent runtime with tool calling and state management
@earendil-works/pi-coding-agentInteractive coding agent CLI
@earendil-works/pi-tuiTerminal UI library with differential rendering

For Slack/chat automation and workflows see earendil-works/pi-chat.

Contributing

See CONTRIBUTING.md for contribution guidelines and AGENTS.md for project-specific rules (for both humans and agents).

Development

bash
npm install          # Install all dependencies
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 publishing.
  • 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.

License

MIT