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)

Searching Database…

116K ·GitHub
Что это такое?Pi — это набор инструментов для создания и запуска ИИ-агентов: в него входят интерактивный CLI-агент для программирования, который можно расширять самому, унифицированный API для LLM нескольких провайдеров, среда выполнения агентов и библиотека терминального интерфейса.
Это один CLI-инструмент или набор пакетов?Это монорепозиторий из отдельных npm-пакетов: pi-coding-agent (CLI), pi-agent-core (среда выполнения агентов с вызовом инструментов и управлением состоянием), pi-ai (унифицированный API для LLM), pi-tui (библиотека терминального интерфейса), а также chord и pi-telemetry для композиции и телеметрии.
Как запустить CLI-агент для программирования?Можно установить npm-пакет pi-coding-agent или скачать архив с исходниками из релиза на GitHub (проверив его по файлу SHA256SUMS) и запустить входящий скрипт сборки, передав флаг --skip-install, если зависимости уже установлены.
С какими провайдерами LLM он работает и нужен ли мне API-ключ?pi-ai работает с OpenAI, Anthropic, Google и другими провайдерами через единый API, поэтому нужен API-ключ того провайдера, которого вы используете. Для запуска также требуется Node.js версии 22.19 или новее.
Ограничивает ли Pi то, к чему агент может обращаться на моём компьютере?Нет, встроенной системы разрешений нет: по умолчанию Pi работает с полными правами пользователя и процесса, которые его запустили, и свободно обращается к файловой системе, процессам, сети и учётным данным. Для более надёжных границ нужно самостоятельно поместить его в контейнер или песочницу, например с помощью расширения Gondolin, обычного Docker или OpenShell.
Что такое chord?Chord — это отдельная самостоятельная среда выполнения для композиции приложений, которая входит в тот же монорепозиторий и отвечает за сервисы, реплицированное состояние, RPC и плагины.
Могу ли я запустить Pi в песочнице ради безопасности?Да, в документации описаны три варианта: расширение Gondolin (направляет инструменты в локальную Linux-микро-ВМ, сохраняя аутентификацию на хосте), запуск всего процесса в обычном Docker или запуск внутри песочницы OpenShell с настраиваемыми политиками.
Есть ли интеграция со Slack или другими чатами?Автоматизация чатов и рабочие процессы, например для Slack, реализованы в отдельном проекте earendil-works/pi-chat, а не в этом репозитории.
Могу ли я поделиться своими сессиями работы агента с другими?Да, сопутствующий инструмент pi-share-hf позволяет публиковать логи ваших сессий Pi на Hugging Face, помогая улучшать агентов для программирования на данных о реальных задачах.
What are similar projects?qwen-code, PiG, openrig, gitagent, cocode, claw-code, jcode, deer-flow
Size
83.2 MB
Stars
116K
Age
1y
Commits · 90 Days