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 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「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。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「All Packages」など複数の箇所に分かれています。確認できる情報は次の通りです。| Package | Description | |---------|-------------| | @earendil-works/pi-ai | Terminal UI library with differential rendering |。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は 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」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「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ともあります。