Документация Pi

Pi — минималистичный фреймворк для coding Agent в терминале. Его ядро остается небольшим, а возможности расширяются через TypeScript-расширения, Skills, Prompt Templates, Themes и Pi Packages.

Установите Pi с помощью npm:

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

--ignore-scripts отключает сценарии жизненного цикла зависимостей во время установки. Для обычной установки Pi через npm сценарии установки не требуются.

В Linux или macOS можно также использовать установщик:

curl -fsSL https://pi.dev/install.sh | sh

Чтобы удалить сам Pi, установленный через установщик curl или npm, используйте npm:

npm uninstall -g @earendil-works/pi-coding-agent

При установке через pnpm, Yarn или Bun используйте соответствующую глобальную команду удаления: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent или bun uninstall -g @earendil-works/pi-coding-agent.

Затем запустите Pi в каталоге проекта:

pi

Для Provider с подпиской выполните аутентификацию через /login; для Provider с API key задайте ключ, например ANTHROPIC_API_KEY, до запуска pi.

Полный сценарий первого запуска приведен в Quickstart.

• Quickstart — установить Pi, пройти аутентификацию и начать первый сеанс.
• Using Pi — интерактивный режим, slash commands, context files и справочник CLI.
• Providers — настройка подписки и API key для встроенных Provider.
• llama.cpp — запустить локальный маршрутизатор и управлять моделями через /llama.
• Security — доверие к проекту, границы sandbox и сообщение об уязвимостях.
• Containerization — изолировать pi в sandbox с помощью Gondolin, Docker или OpenShell.
• Settings — глобальные настройки и настройки проекта.
• Keybindings — сочетания клавиш по умолчанию и пользовательские keybindings.
• Sessions — управление сеансами, ветвление и навигация по дереву.
• Compaction — сжатие контекста и сводки веток.

• Extensions — TypeScript-модули для инструментов, команд, событий и пользовательского UI.
• Skills — Agent Skills для переиспользуемых возможностей по требованию.
• Prompt templates — переиспользуемые prompts, разворачиваемые через slash commands.
• Themes — встроенные и пользовательские темы терминала.
• Pi packages — объединять и делиться расширениями, Skills, prompts и темами.
• Custom models — добавить записи моделей для поддерживаемых API Provider.
• Custom providers — реализовать пользовательские API и OAuth-потоки.

• SDK — встроить pi в приложения Node.js.
• RPC mode — интегрировать через stdin/stdout JSONL.
• JSON event stream mode — print mode со структурированными событиями.
• TUI components — создать пользовательский терминальный UI для расширений.

• Environment variables — конфигурация процесса Pi и метаданные сеанса, доступные инструментам bash.
• Session format — формат JSONL-файла сеанса, типы записей и API SessionManager.

• Windows
• Termux on Android
• tmux
• Terminal setup
• Shell aliases

• Development — локальная настройка, структура проекта и отладка.