Pi Agent CLI リファレンスマニュアル
以下は Pi Agent の一般的なコマンドライン引数のリファレンスです。
モードオプション
以下の引数は Pi Agent の実行モードを制御します。未指定の場合はデフォルトでインタラクティブインターフェースに入ります。
| 引数 | 説明 | 例 |
|---|---|---|
| (デフォルト) | インタラクティブモード、ターミナル TUI インターフェース | pi |
| -p, --print | Print モード、結果を出力して終了 | pi -p "コードを要約" |
| --mode json | JSON モード、すべてのイベントが JSON 行として出力される | pi --mode json -p "要約" |
| --mode rpc | RPC モード、stdin/stdout JSONL プロトコル | pi --mode rpc |
| --export <入力> [出力] | セッションを HTML としてエクスポート、出力パスは省略可能 | pi --export abc123 session.html |
モデルオプション
以下の引数はプロバイダー、モデル、推論レベルを指定するために使用し、設定ファイルを変更せずに一時的に切り替えるのに適しています。
| 引数 | 説明 | 例 |
|---|---|---|
| --provider name | AI プロバイダーを指定 | pi --provider anthropic |
| --model pattern | モデル ID、provider/id および :thinking 形式に対応 | pi --model openai/gpt-4o pi --model sonnet:high |
| --api-key key | API Key を直接渡す、優先度最高。例の値は自分の Key に置き換える必要があります | pi --api-key sk-ant-api03-xxxx |
| --thinking level | 推論レベル:off/minimal/low/medium/high/xhigh/max | pi --thinking high |
| --models patterns | カンマ区切りのモデルリスト、Ctrl+P の循環を制限 | pi --models "claude-*,gpt-4o" |
| --list-models | 利用可能なすべてのモデルを一覧表示 | pi --list-models |
セッションオプション
以下の引数は、今回の実行でどのセッションを使用するか、およびセッションファイルの保存場所を決定します。
| 引数 | 説明 | 例 |
|---|---|---|
| -c, --continue | 最近のセッションを続行 | pi -c |
| -r, --resume | 履歴セッションを参照して選択 | pi -r |
| --session path|id | 指定したセッションファイルまたは UUID を使用 | pi --session abc123 |
| --fork path|id | 指定したセッションから新しいセッションをフォーク | pi --fork abc123 |
| --session-dir dir | セッション保存ディレクトリをカスタマイズ、デフォルトディレクトリは ~/.pi/agent/sessions/。この引数はそれを一時的に置き換えるために使用します | pi --session-dir .pi/sessions |
| --no-session | 一時モード、セッションを保存しない | pi --no-session |
| -n, --name name | セッションの表示名を設定 | pi --name "認証モジュールをリファクタリング" |
ツールオプション
以下の引数は組み込みツールの利用範囲を制御し、権限を厳しくしたり純粋な会話を行うために使用します。
| 引数 | 説明 | 例 |
|---|---|---|
| -t, --tools list | ホワイトリストでツールを指定、カンマ区切り | pi --tools read,bash,edit,write |
| -xt, --exclude-tools list | 指定したツールを無効化、カンマ区切り | pi --exclude-tools bash |
| -nbt, --no-builtin-tools | すべての組み込みツールを無効化、拡張ツールは保持 | pi --no-builtin-tools |
| -nt, --no-tools | すべてのツールを無効化、純粋な会話モード | pi --no-tools |
リソースオプション
以下の引数は拡張機能、Skill、テンプレート、テーマの読み込みを制御します。--no- プレフィックス付きの引数は自動検出を無効にするために使用します。
| 引数 | 説明 | 例 |
|---|---|---|
| -e, --extension source | 拡張機能を読み込む、繰り返し使用可能 | pi -e ./my-ext.ts -e npm:@foo/bar |
| --no-extensions | 拡張機能の自動検出を無効化 | pi --no-extensions |
| --skill path | Skill を読み込む、繰り返し使用可能 | pi --skill ./my-skill |
| --no-skills | Skill の自動検出を無効化 | pi --no-skills |
| --prompt-template path | プロンプトテンプレートを読み込む、繰り返し使用可能 | pi --prompt-template ./review.md |
| --no-prompt-templates | テンプレートの自動検出を無効化 | pi --no-prompt-templates |
| --theme path | テーマを読み込む、繰り返し使用可能 | pi --theme ./my-theme.json |
| --no-themes | テーマの自動検出を無効化 | pi --no-themes |
| -nc, --no-context-files | AGENTS.md/CLAUDE.md の読み込みを無効化 | pi -nc |
その他のオプション
以下の引数はシステムプロンプト、プロジェクト信頼、ヘルプ情報などの動作を上書きします。
| 引数 | 説明 | 例 |
|---|---|---|
| --system-prompt text | デフォルトのシステムプロンプトを置き換え | pi --system-prompt "あなたは Python の専門家です" |
| --append-system-prompt text | システムプロンプトに追加 | pi --append-system-prompt "中国語で返信してください" |
| --tui-mode | インターフェースモード、例: fullscreen。未指定の場合は通常(regular)モード | pi --tui-mode fullscreen |
| --use-theme | テーマを指定して読み込む、今回の実行のみ有効で設定は変更しない | pi --use-theme "dark-plus" |
| --verbose | 詳細な起動情報を強制的に表示 | pi --verbose |
| -a, --approve | 今回の実行でプロジェクトのローカルファイルを信頼 | pi -a |
| -na, --no-approve | 今回の実行でプロジェクトのローカルファイルを信頼しない | pi -na |
| -- | 区切り文字。その後の内容はそのまま prompt に渡される | pi -- @notes.md このノートを要約 |
| -h, --help | ヘルプ情報を表示 | pi -h |
| -v, --version | バージョン番号を表示 | pi -v |
-aと-na相互排他です。同じ実行で指定できるのはそのうちの1つのみです。
両方の有効範囲は今回の実行のみに限られ、trust.json には書き込まれません。
pi サブコマンド
起動引数の他に、pi は拡張パッケージと自身の更新を管理する一連のサブコマンドを提供します。
| サブコマンド | 説明 |
|---|---|
| pi install <source> | 拡張パッケージをインストール、-l を付けるとプロジェクトローカルにインストール |
| pi remove <source> | インストール済みの拡張パッケージを削除 |
| pi uninstall <source> | remove のエイリアス、同じ効果 |
| pi list | インストール済みの拡張パッケージを一覧表示 |
| pi update | pi 自身と拡張パッケージを更新、--self、--all、--models、--extensions、--extension <source> に対応 |
| pi config | 拡張パッケージが提供する各種リソースを有効化または無効化 |
関連環境変数
以下の環境変数は認証、ネットワーク、ターミナルの表示に影響し、コマンドライン引数以外の補足設定として使用できます。
| 変数 | 作用 | 例 |
|---|---|---|
| ANTHROPIC_API_KEY | Anthropic 認証の代替方法。/login によるサブスクリプションログインを行っていない場合に使用 | sk-ant-api03-xxxx |
| HTTP_PROXY / HTTPS_PROXY | API リクエストにプロキシサーバーを指定 | http://127.0.0.1:7890 |
| NO_PROXY | プロキシホワイトリスト。一致したホストはプロキシを経由しない | localhost,127.0.0.1 |
| COLORTERM | truecolor 自動検出の参考値の1つ。検出に失敗した場合は PI_TRUE_COLOR=1 で強制的に有効化するか、terminal.trueColor を設定 | truecolor |
長期的に使用するプロキシは書き込むことを推奨します~/.pi/agent/settings.jsonのhttpProxy。
この設定はグローバル設定ファイルでのみ有効です。プロジェクトレベルに記述しても.pi/settings.jsonでは無効です。
ファイルパラメータ
使用@プレフィックスでファイルを参照:
$ pi @prompt.md "回答这个问题" $ pi -p @screenshot.png "图中有什么" $ pi @src/code.ts @src/test.ts "对比这两个文件"
2番目のコマンドを例にとると、出力は次のようになります:
図はログインページのスクリーンショットで、ページにはユーザー名入力欄、パスワード入力欄、およびログインボタンが含まれています。その他の拡張機能