Tài liệu Pi

Pi là một framework coding Agent tối giản chạy trong terminal. Phần lõi được giữ nhỏ gọn nhưng có thể mở rộng bằng extension TypeScript, Skills, Prompt Templates, Themes và Pi Packages.

Cài đặt Pi bằng 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 của dependency trong khi cài đặt. Pi không cần tập lệnh cài đặt trong các lần cài npm thông thường.

Trên Linux hoặc macOS, bạn cũng có thể dùng trình cài đặt:

curl -fsSL https://pi.dev/install.sh | sh

Để gỡ chính Pi được cài qua trình cài đặt curl hoặc npm, hãy dùng npm:

npm uninstall -g @earendil-works/pi-coding-agent

Nếu cài bằng pnpm, Yarn hoặc Bun, hãy dùng lệnh gỡ cài đặt toàn cục tương ứng: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent hoặc bun uninstall -g @earendil-works/pi-coding-agent.

Sau đó chạy trong thư mục dự án:

pi

Xác thực bằng /login cho Provider theo gói thuê bao hoặc đặt API key như ANTHROPIC_API_KEY trước khi khởi động pi.

Xem Quickstart để biết đầy đủ quy trình chạy lần đầu.

• Quickstart - cài đặt, xác thực và bắt đầu phiên đầu tiên.
• Using Pi - chế độ tương tác, slash commands, context files và tham khảo CLI.
• Providers - thiết lập gói thuê bao và API key cho Provider tích hợp sẵn.
• llama.cpp - chạy bộ định tuyến cục bộ và quản lý mô hình bằng /llama.
• Security - độ tin cậy của dự án, ranh giới sandbox và báo cáo lỗ hổng.
• Containerization - cô lập pi trong sandbox bằng Gondolin, Docker hoặc OpenShell.
• Settings - cài đặt toàn cục và theo dự án.
• Keybindings - phím tắt mặc định và keybinding tùy chỉnh.
• Sessions - quản lý phiên, phân nhánh và điều hướng cây.
• Compaction - nén ngữ cảnh và tóm tắt nhánh.

• Extensions - mô-đun TypeScript cho tool, lệnh, sự kiện và UI tùy chỉnh.
• Skills - Agent Skills cho các khả năng theo yêu cầu có thể tái sử dụng.
• Prompt templates - prompt có thể tái sử dụng, mở rộng từ slash commands.
• Themes - chủ đề terminal tích hợp sẵn và tùy chỉnh.
• Pi packages - đóng gói và chia sẻ extension, Skills, prompt và chủ đề.
• Custom models - thêm mục mô hình cho các API Provider được hỗ trợ.
• Custom providers - triển khai API và luồng OAuth tùy chỉnh.

• SDK - nhúng pi vào ứng dụng Node.js.
• RPC mode - tích hợp qua stdin/stdout JSONL.
• JSON event stream mode - print mode với các sự kiện có cấu trúc.
• TUI components - xây dựng UI terminal tùy chỉnh cho extension.

• Environment variables - cấu hình tiến trình Pi và siêu dữ liệu phiên mà các tool bash có thể dùng.
• Session format - định dạng tệp phiên JSONL, các loại mục nhập và API SessionManager.

• Windows
• Termux on Android
• tmux
• Terminal setup
• Shell aliases

• Development - thiết lập cục bộ, cấu trúc dự án và gỡ lỗi.