Bắt đầu nhanh

Trang này đưa bạn từ bước cài đặt đến phiên pi đầu tiên có ích.

Pi được phân phối dưới dạng gói npm:

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

--ignore-scripts tắt các script vòng đời của dependency trong khi cài đặt. Pi không cần script cài đặt cho các lượt cài đặt npm thông thường.

Hãy dùng đúng trình quản lý gói đã cài pi. Trình cài đặt curl dùng npm ở phạm vi global, nên các bản cài qua curl hoặc npm đều được gỡ bằng 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

Gỡ cài đặt pi vẫn giữ lại cài đặt, thông tin xác thực, phiên và các gói pi đã cài trong ~/.pi/agent/.

Sau đó khởi động pi trong thư mục dự án mà bạn muốn nó làm việc:

cd /path/to/project
pi

Pi có thể dùng provider dạng subscription thông qua /login, hoặc provider dùng API key thông qua biến môi trường hay tệp auth.

Khởi động pi và chạy:

/login

Sau đó chọn một Provider. Các đăng nhập subscription tích hợp sẵn gồm Claude Pro/Max, ChatGPT Plus/Pro (Codex) và GitHub Copilot.

Đặt API key trước khi khởi động pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Bạn cũng có thể chạy /login và chọn Provider dùng API key để lưu key vào ~/.pi/agent/auth.json.

Xem Providers để biết toàn bộ Provider được hỗ trợ, biến môi trường và cách thiết lập cloud provider.

Khi pi khởi động, nhập một yêu cầu rồi nhấn Enter:

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

Theo mặc định, pi cung cấp cho mô hình bốn công cụ:

• read - đọc tệp
• write - tạo hoặc ghi đè tệp
• edit - sửa tệp bằng patch
• bash - chạy lệnh Shell

Các công cụ read-only tích hợp bổ sung (grep, find, ls) có thể được bật qua tùy chọn công cụ. Pi chạy trong thư mục làm việc hiện tại và có thể sửa các tệp ở đó. Hãy dùng Git hoặc workflow checkpoint khác nếu bạn muốn dễ dàng quay lại trạng thái trước.

Pi tải context files khi khởi động. Thêm tệp AGENTS.md để cho Pi biết cách làm việc trong dự án:

# Project Instructions

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

Pi tải:

• ~/.pi/agent/AGENTS.md cho chỉ dẫn global
• AGENTS.md hoặc CLAUDE.md từ các thư mục cha và thư mục hiện tại

Nếu một thư mục chứa AGENTS.override.md, Pi sẽ tải tệp đó thay vì AGENTS.md hoặc CLAUDE.md trong cùng thư mục.

Khởi động lại pi hoặc chạy /reload sau khi thay đổi context files.

Gõ @ trong editor để fuzzy search tệp, hoặc truyền tệp trên dòng lệnh:

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

Có thể dán ảnh hoặc văn bản bằng Ctrl+V (Alt+V trên Windows); ảnh cũng có thể được kéo vào các terminal được hỗ trợ.

Trong chế độ tương tác:

!npm run lint

Đầu ra của lệnh được gửi cho mô hình. Dùng !!command để chạy lệnh mà không thêm đầu ra của nó vào ngữ cảnh mô hình.

Dùng /model hoặc Ctrl+L để chọn mô hình. Dùng Shift+Tab để đổi thinking level. Dùng Ctrl+P / Shift+Ctrl+P để chuyển qua scoped models.

Phiên được lưu tự động:

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

Bên trong pi, dùng /resume, /new, /tree, /fork và /clone để quản lý phiên.

Cho các Prompt chạy một lần:

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

Dùng --mode json để xuất JSON event, hoặc --mode rpc để tích hợp với tiến trình khác.

• Using Pi - chế độ tương tác, slash commands, phiên, context files và tham chiếu CLI.
• Providers - xác thực và thiết lập mô hình.
• Settings - cấu hình global và dự án.
• Keybindings - phím tắt và tùy chỉnh.
• Pi Packages - cài đặt Extensions, Skills, Prompts và Themes dùng chung.

Ghi chú nền tảng: Windows, Termux, tmux, Terminal setup, Shell aliases.