Cấu hình, tùy chỉnh, thiết lập nền tảng và tham chiếu API cho Pi.

Bắt đầu nhanh

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

Cài đặt

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 vô hiệu hóa các tập lệnh vòng đời phụ thuộc trong khi cài đặt. Pi không yêu cầu tập lệnh cài đặt cho các lần cài đặt npm thông thường.

Gỡ cài đặt

Sử dụng trình quản lý gói đã cài đặt pi. Trình cài đặt Curl sử dụng npm trên toàn cầu, do đó, các lượt cài đặt Curl và npm sẽ bị xóa 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 để lại cài đặt, thông tin xác thực, phiên và gói pi đã cài đặt trong ~/.pi/agent/.

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

cd /path/to/project
pi

Xác thực

Pi có thể sử dụng subscription providers đến /login hoặc nhà cung cấp khóa API thông qua các biến môi trường hoặc tệp xác thực.

Tùy chọn 1: đăng nhập đăng ký

Bắt đầu pi và chạy:

/login

Sau đó chọn nhà cung cấp. Thông tin đăng nhập đăng ký tích hợp bao gồm Claude Pro/Max, ChatGPT Plus/Pro (Codex) và GitHub Copilot.

Tùy chọn 2: API key

Đặt API key trước khi khởi chạy pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Bạn cũng có thể chạy /login và chọn nhà cung cấp khóa API để lưu trữ khóa trong ~/.pi/agent/auth.json.

Xem Providers để biết tất cả các nhà cung cấp được hỗ trợ, biến môi trường và thiết lập nhà cung cấp đám mây.

Buổi đầu tiên

Khi pi khởi động, hãy nhập yêu cầu và 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 tin
  • write - tạo hoặc ghi đè lên tập tin
  • edit - vá các tập tin
  • bash - chạy lệnh shell

Các công cụ chỉ đọc tích hợp bổ sung (grep, find, ls) có sẵn thông qua các tùy chọn công cụ. Pi chạy trong thư mục làm việc hiện tại của bạn và có thể sửa đổi các tệp ở đó. Sử dụng git hoặc quy trình kiểm tra điểm kiểm tra khác nếu bạn muốn khôi phục dễ dàng.

Đưa ra hướng dẫn dự án pi

Pi tải context files khi khởi động. Thêm tệp AGENTS.md để cho nó 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 để được hướng dẫn chung
  • AGENTS.md hoặc CLAUDE.md từ thư mục mẹ và thư mục hiện tại

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

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

Những điều phổ biến để thử

Tệp tham khảo

Nhập @ trong trình chỉnh sửa để tìm kiếm tệp mờ 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 hình ảnh hoặc văn bản bằng Ctrl+V (Alt+V trên Windows); hình ảnh cũng có thể được kéo vào các thiết bị đầu cuối được hỗ trợ.

Chạy lệnh shell

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

!npm run lint

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

Chuyển đổi mô hình

Sử dụng /model hoặc Ctrl+L để chọn mô hình. Sử dụng Shift+Tab để xoay vòng mức độ tư duy. Sử dụng Ctrl+P / Shift+Ctrl+P để duyệt qua các mô hình có phạm vi.

Tiếp tục sau

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, sử dụng /resume, /new, /tree, /fork/clone để quản lý phiên.

Chế độ không tương tác

Đối với lời nhắc 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?"

Sử dụng --mode json cho đầu ra sự kiện JSON hoặc --mode rpc để tích hợp quy trình.

Các bước tiếp theo

  • Using Pi - chế độ tương tác, slash commands, phiên, context files và CLI tham chiếu.
  • Providers - xác thực và thiết lập mô hình.
  • Settings - cấu hình toàn cầu và dự án.
  • Keybindings - phím tắt và tùy chỉnh.
  • Pi Packages - cài đặt các tiện ích mở rộng, kỹ năng, lời nhắc và chủ đề được chia sẻ.

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