earendil-works/pi:README 來源編輯指南
根據 README、倉庫資料與授權整理 earendil-works/pi 的安裝與核驗路徑。
專案定位
earendil-works/pi 的 README 將專案描述為「AI agent toolkit: unified LLM API, agent loop, TUI, coding agent CLI」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:> New issues and PRs from new contributors are auto-closed by default. Maintainers review auto-closed issues daily. See CONTRIBUTING.md.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Pi Agent Harness」與相關條目,可以先判斷它是否處理你的實際問題:@earendil-works/pi-agent-core: Agent runtime with tool calling and state management。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:@earendil-works/pi-coding-agent: Interactive coding agent CLI。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「All Packages」等段落。可確認的線索包括:| Package | Description | |---------|-------------| | @earendil-works/pi-ai | Terminal UI library with differential rendering |。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: npm install --ignore-scripts # Install all dependencies without running lifecycle scripts npm run build # Refresh model data, then build all packages npm run build:offline # Rebuild using existing model data without network access npm run check # Lint, format, and type check ./test.sh # Run tests (skips LLM-dependent tests without API keys) ./pi-test.sh # Run pi from sources (can be run from any directory) 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「All Packages」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「All Packages」段落提到:For Slack/chat automation and workflows see earendil-works/pi-chat.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Read the documentation, but you can also ask the agent to explain itself。