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

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

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

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

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

Используйте тот менеджер пакетов, которым был установлен 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 может использовать провайдеры подписки через /login, а провайдеры с API key — через переменные окружения или файл аутентификации.

Запустите pi и выполните:

/login

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

Задайте API key перед запуском pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Можно также выполнить /login и выбрать провайдера с API key, чтобы сохранить ключ в ~/.pi/agent/auth.json.

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

Когда pi запустится, введите запрос и нажмите Enter:

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

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

• read - читать файлы
• write - создавать или перезаписывать файлы
• edit - изменять файлы через patch
• bash - выполнять Shell-команды

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

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 из этого каталога.

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

Введите @ в редакторе, чтобы выполнить fuzzy search по файлам, или передайте файлы в командной строке:

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, чтобы переключать thinking level. Используйте Ctrl+P / Shift+Ctrl+P, чтобы переключаться между scoped models.

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

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 для управления сессиями.

Для одноразовых Prompt:

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 - установка общих Extensions, Skills, Prompts и Themes.

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