Pi ドキュメント

Pi は、ターミナルで動作する最小限の coding Agent フレームワークです。コアを小さく保ちながら、TypeScript 拡張機能、Skills、Prompt Templates、Themes、Pi Packages で拡張できます。

クイックスタート

npm で Pi をインストールします。

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

--ignore-scripts は、インストール中に依存関係のライフサイクルスクリプトを無効にします。通常の npm インストールでは、Pi にインストールスクリプトは必要ありません。

Linux または macOS では、インストーラーも利用できます。

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

curl のインストーラーまたは npm でインストールした Pi 自体をアンインストールするには、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

サブスクリプション Provider は /login で認証するか、pi を起動する前に ANTHROPIC_API_KEY などの API key を設定します。

初回実行の完全な流れは Quickstart を参照してください。

まず読む

Quickstart - インストール、認証、最初のセッションの開始。
Using Pi - インタラクティブモード、slash commands、context files、CLI リファレンス。
Providers - 組み込み Provider のサブスクリプションと API key の設定。
llama.cpp - ローカルルーターを実行し、/llama でモデルを管理。
Security - プロジェクトの信頼、sandbox の境界、脆弱性報告。
Containerization - Gondolin、Docker、OpenShell を使って pi を sandbox で隔離。
Settings - グローバル設定とプロジェクト設定。
Keybindings - 既定のショートカットとカスタムキーバインド。
Sessions - セッション管理、分岐、ツリーのナビゲーション。
Compaction - コンテキストの圧縮とブランチの要約。

カスタマイズ

Extensions - ツール、コマンド、イベント、カスタム UI 用の TypeScript モジュール。
Skills - 再利用可能なオンデマンド機能を提供する Agent Skills。
Prompt templates - slash commands から展開できる再利用可能なプロンプト。
Themes - 組み込みおよびカスタムのターミナルテーマ。
Pi packages - 拡張機能、Skills、プロンプト、テーマのバンドルと共有。
Custom models - 対応する Provider API 用のモデルエントリを追加。
Custom providers - カスタム API と OAuth フローを実装。

プログラムからの利用

SDK - Node.js アプリケーションに pi を組み込む。
RPC mode - stdin/stdout JSONL を介して連携。
JSON event stream mode - 構造化イベントを出力する print mode。
TUI components - 拡張機能用のカスタムターミナル UI を構築。

リファレンス

Environment variables - bash ツールから利用できる Pi のプロセス設定とセッションメタデータ。
Session format - JSONL セッションファイル形式、エントリの種類、SessionManager API。

プラットフォームのセットアップ

開発

Development - ローカルセットアップ、プロジェクト構造、デバッグ。