Настройка, расширение, параметры платформы и справочник API для Pi.

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

Pi — это минимальный жгут кодирования клемм. Он разработан так, чтобы оставаться небольшим по своей сути, но при этом расширяться за счет TypeScript расширений, навыков, prompt templates, тем и пакетов pi.

Быстрый старт

Установите 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, используйте npm для установки Curl и 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

Аутентифицируйтесь с помощью /login для subscription providers или установите API key, например ANTHROPIC_API_KEY, перед запуском pi.

Полную информацию о первом запуске см. в Quickstart.

Начните здесь

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

Кастомизация

  • Extensions–TypeScript модули для инструментов, команд, событий и пользовательского интерфейса.
  • Skills — Агент Skills для многократного использования возможностей по требованию.
  • Prompt templates — многоразовые подсказки, которые расширяются от slash commands.
  • Themes - встроенный и пользовательский terminal themes.
  • Pi packages — объединяйте и делитесь расширениями, навыками, подсказками и темами.
  • Custom models — добавить записи модели для поддерживаемого поставщика API.
  • Custom providers — реализовать пользовательские потоки API и OAuth.

Программное использование

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

Ссылка

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

Настройка платформы

Разработка

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