日本語ドキュメント

Pi の設定、拡張、プラットフォーム設定、API リファレンス。

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 自体をアンインストールするには、curl に npm を使用し、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

pi を開始する前に、subscription providers に対して /login で認証するか、ANTHROPIC_API_KEY などの 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 - サポートされているプロバイダー API のモデル エントリを追加します。
  • Custom providers - カスタム API および OAuth フローを実装します。

プログラムによる使用

  • SDK - Node.js アプリケーションに pi を埋め込みます。
  • RPC mode - stdin/stdout JSONL を積分します。
  • JSON event stream mode - 構造化されたイベントを含む印刷モード。
  • TUI components - 拡張機能用のカスタム ターミナル UI を構築します。

参照

  • Environment variables - Pi プロセス構成とセッション メタデータは bash ツールで使用できます。
  • Session format - JSONL セッション ファイル形式、エントリ タイプ、および SessionManager API。

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

発達

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