pi README

The project's README from github.com/earendil-works/pi. As one markdown file: README.md.

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/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:

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.

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

pi.dev domain graciously donated by

Exy mascot
exe.dev

pi (earendil-works/pi)

tui
Searching Database…

116K ·GitHub
Pi
What is this?Pi is an agent harness: a toolkit of packages for building and running AI agents, including a self-extensible interactive coding agent CLI, a unified multi-provider LLM API, an agent runtime, and a terminal UI library.
Is this one CLI tool or a collection of packages?It is a monorepo of separate npm packages: pi-coding-agent (the CLI), pi-agent-core (agent runtime with tool calling/state), pi-ai (unified LLM API), pi-tui (terminal UI library), plus chord and pi-telemetry for composition and telemetry.
How do I get the coding agent CLI running?You can install the pi-coding-agent npm package, or download a GitHub release's source archive (verified via its SHA256SUMS file) and run the included build script, passing --skip-install if dependencies are already present.
Which LLM providers does it work with, and do I need an API key?pi-ai talks to OpenAI, Anthropic, Google and other providers through one unified API, so you need an API key for whichever provider you use. Running it also requires Node.js 22.19 or newer.
Does Pi restrict what the agent can access on my machine?No, there's no built-in permission system: by default Pi runs with the full permissions of the user and process that launched it, touching filesystem, processes, network and credentials freely. For stronger boundaries you have to containerize or sandbox it yourself, e.g. via the Gondolin extension, plain Docker, or OpenShell.
What is chord?Chord is a separate standalone application-composition runtime included in the same monorepo, handling services, replicated state, RPC, and plugins.
Can I run Pi in a sandbox for safety?Yes, the docs describe three patterns: the Gondolin extension (routes tools into a local Linux micro-VM while keeping auth on the host), running the whole process in plain Docker, or running it inside OpenShell's policy-controlled sandbox.
Is there a Slack or chat integration?Chat automation and workflows like Slack are handled by the separate earendil-works/pi-chat project, not this repo.
Can I share my coding agent sessions with others?Yes, the companion tool pi-share-hf lets you publish your Pi session logs to Hugging Face, helping improve coding agents with real-world task data.
What are similar projects?qwen-code, PiG, openrig, gitagent, cocode, claw-code, jcode, deer-flow
Which topics is it in?harness, agent-framework, tui, sdk, coding-agent, openai, agent, api, terminal, ai-agents, llm, nodejs
Creator
earendil-works
Size
83.2 MB
Stars
116K
Updated
CommitOct 18Releasev1.3.0Oct 15
Age
1y
Commits · 90 Days