Pi 文檔

Pi 是最小的端子編碼線束。它的設計目的是保持核心較小，同時透過 TypeScript 擴充、技能、prompt templates、主題和 pi 套件進行擴充。

安裝 Pi 和 npm：

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

--ignore-scripts 在安裝過程中停用依賴生命週期腳本。 Pi 不需要正常安裝npm 安裝腳本。

在 Linux 或 macOS 上，您也可以使用安裝程式：

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

要卸載 pi 本身，請使用 npm 進行curl 並使用 npm 安裝：

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

對於 pnpm、Yarn 或 Bun 安裝，請使用相符的全域刪除指令：pnpm remove -g @earendil-works/pi-coding-agent、yarn global remove @earendil-works/pi-coding-agent 或 bun uninstall -g @earendil-works/pi-coding-agent。

然後在專案目錄中運行它：

pi

使用/login對subscription providers進行身份驗證，或在啟動pi之前設定API key，例如ANTHROPIC_API_KEY。

有關完整的首次運行流程，請參閱Quickstart。

• Quickstart - 安裝、驗證並執行第一個會話。
• Using Pi - 互動模式、slash commands、context files 和 CLI 參考。
• Providers - 內建提供者的訂閱和API金鑰設定。
• llama.cpp - 運行本機路由器並使用/llama管理模型。
• Security - 專案信任、sandbox 邊界和漏洞報告。
• Containerization - sandbox pi 與 Gondolin、Docker 或 OpenShell。
• Settings - 全域和專案設定。
• Keybindings - 預設快捷鍵和自訂按鍵綁定。
• Sessions - 會話管理、分支和樹導航。
• Compaction - context compaction 和 branch summarization。

• Extensions - TypeScript 工具、指令、事件和自訂 UI 模組。
• Skills - 代理Skills，用於可重複使用的按需功能。
• Prompt templates - 從 slash commands 擴展的可重複使用的提示。
• Themes - 內建與自訂terminal themes。
• Pi packages - 捆綁並分享擴充、技能、提示和主題。
• Custom models - 為支援的提供者APIs 新增模型條目。
• Custom providers - 實作自訂 API 和 OAuth 流程。

• SDK - 將 pi 嵌入到 Node.js 應用程式中。
• RPC mode - 對 stdin/stdout JSONL 進行積分。
• JSON event stream mode - 具有結構化事件的列印模式。
• TUI components - 為擴充功能建立自訂終端 UI。

• Environment variables - Pi bash 工具可用的流程配置和會話元資料。
• Session format - JSONL 會話檔案格式、條目類型和 SessionManager API。

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

• Development - 本地設定、專案結構和調試。