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

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

Эта страница поможет вам перейти от установки к полезному первому сеансу Pi.

Установить

Pi распространяется как пакет npm:

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

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

Удалить

Используйте менеджер пакетов, который установил pi. Установщик Curl использует npm глобально, поэтому установки Curl и npm удаляются с помощью npm:

# curl installer or npm install -g
npm uninstall -g @earendil-works/pi-coding-agent

# pnpm
pnpm remove -g @earendil-works/pi-coding-agent

# Yarn
yarn global remove @earendil-works/pi-coding-agent

# Bun
bun uninstall -g @earendil-works/pi-coding-agent

При удалении pi настройки, учетные данные, сеансы и установленные пакеты pi остаются в ~/.pi/agent/.

Затем запустите pi в каталоге проекта, над которым вы хотите, чтобы он работал:

cd /path/to/project
pi

Аутентификация

Pi может использовать поставщиков ключей с subscription providers по /login или API через переменные среды или файл аутентификации.

Вариант 1: вход в подписку

Запустите pi и запустите:

/login

Затем выберите провайдера. Встроенные входы по подписке включают Claude Pro/Max, ChatGPT Plus/Pro (Codex) и GitHub Copilot.

Вариант 2: API key

Установите API key перед запуском pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Вы также можете запустить /login и выбрать поставщика API-ключа для хранения ключа в ~/.pi/agent/auth.json.

См. Providers для всех поддерживаемых поставщиков, переменных среды и настройки облачного провайдера.

Первая сессия

После запуска pi введите запрос и нажмите Enter:

Summarize this repository and tell me how to run its checks.

По умолчанию pi предоставляет модели четыре инструмента:

  • read - читать файлы
  • write — создать или перезаписать файлы
  • edit — файлы патчей
  • bash — запустить команды оболочки

Дополнительные встроенные инструменты, доступные только для чтения (grep, find, ls), доступны через параметры инструментов. Pi запускается в вашем текущем рабочем каталоге и может изменять файлы там. Используйте git или другой рабочий процесс контрольных точек, если вы хотите легко откатиться.

Дайте инструкции по пи-проекту

Pi загружает context files при запуске. Добавьте файл AGENTS.md, чтобы указать, как работать в проекте:

# Project Instructions

- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.

Pi нагрузки:

  • ~/.pi/agent/AGENTS.md для глобальных инструкций
  • AGENTS.md или CLAUDE.md из родительских каталогов и текущего каталога

Если каталог содержит AGENTS.override.md, Pi загружает его вместо AGENTS.md или CLAUDE.md из этого каталога.

Перезапустите pi или запустите /reload после изменения context files.

Общие вещи, которые стоит попробовать

Справочные файлы

Введите @ в редакторе для нечеткого поиска файлов или передайте файлы в командной строке:

pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"

Изображения или текст можно вставлять с помощью Ctrl+V (Alt+V в Windows); изображения также можно перетаскивать в поддерживаемые терминалы.

Запуск команд оболочки

В интерактивном режиме:

!npm run lint

Вывод команды отправляется в модель. Используйте !!command, чтобы запустить команду без добавления ее вывода в контекст модели.

Переключение моделей

Используйте /model или Ctrl+L, чтобы выбрать модель. Используйте Shift+Tab для переключения уровня мышления. Используйте Ctrl+P/Shift+Ctrl+P для циклического переключения моделей с ограниченной областью действия.

Продолжить позже

Сессии сохраняются автоматически:

pi -c                  # Continue most recent session
pi -r                  # Browse previous sessions
pi --name "my task"    # Set session display name at startup
pi --session <path|id> # Open a specific session

Внутри pi используйте /resume, /new, /tree, /fork и /clone для управления сеансами.

Неинтерактивный режим

Для одноразовых подсказок:

pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"

Используйте --mode json для вывода событий JSON или --mode rpc для интеграции процесса.

Следующие шаги

  • Using Pi — интерактивный режим, slash commands — сеансы, context files и CLI — ссылка.
  • Providers — аутентификация и настройка модели.
  • Settings — глобальная и проектная конфигурация.
  • Keybindings — ярлыки и настройка.
  • Pi Packages — установка общих расширений, навыков, подсказок и тем.

Примечания к платформе: Windows, Termux, tmux, Terminal setup, Shell aliases.