快速入門

此頁面將帶您從安裝到有用的第一個 pi 會話。

Pi 以 npm 包分發：

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

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

使用安裝 pi 的套件管理器。 curl 安裝程式全域使用 npm，因此使用 npm 刪除curl 和 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使用subscription providers，或透過環境變數或auth檔案使用API金鑰提供程式。

啟動 pi 並運行：

/login

然後選擇一個提供者。內建訂閱登入包括 Claude Pro/Max、ChatGPT Plus/Pro (Codex) 和 GitHub Copilot。

在啟動 pi 之前設定 API key：

export ANTHROPIC_API_KEY=sk-ant-...
pi

您也可以執行 /login 並選擇 API 金鑰提供者以將金鑰儲存在 ~/.pi/agent/auth.json 中。

請參閱 Providers 以了解所有支援的提供者、環境變數和雲端提供者設定。

pi 啟動後，輸入請求並按 Enter：

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

預設情況下，pi 為模型提供了四種工具：

• read - 讀取文件
• write - 建立或覆蓋文件
• edit - 補丁文件
• bash - 運行 shell 指令

其他內建唯讀工具（grep、find、ls）可透過工具選項使用。 Pi 在您目前的工作目錄中運行並可以修改那裡的檔案。如果您想要輕鬆回滾，請使用 git 或其他檢查點工作流程。

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。

在編輯器中輸入 @ 來模糊搜尋文件，或在命令列上傳遞文件：

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

可以使用 Ctrl+V（Windows 上為 Alt+V）貼上圖像或文字；圖像也可以拖曳到支援的終端中。

在互動模式下：

!npm run lint

命令輸出發送到模型。使用 !!command 運行命令而不將其輸出新增至模型上下文。

使用 /model 或 Ctrl+L 選擇模型。使用Shift+Tab循環思考等級。使用 Ctrl+P / Shift+Ctrl+P 循環瀏覽範圍模型。

會話會自動儲存：

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 來管理會話。

對於一次性提示：

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 - 安裝共享擴充功能、技能、提示和主題。

平台備註：Windows、Termux、tmux、Terminal setup、Shell aliases。