クイックスタート

本ページでは、インストールから最初の pi セッションを実用的に使える状態までを案内します。

インストール

Pi は npm パッケージとして配布されています：

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

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

アンインストール

pi をインストールしたパッケージマネージャーを使用してください。curl インストーラーは npm をグローバルに使用するため、curl と npm のインストールは npm で削除します：

# curl インストーラーまたは npm install -g
npm uninstall -g @earendil-works/pi-coding-agent

# pnpm
pnpm remove -g @earendil-works/pi-coding-agent

# Yarn
yarn global remove @earendil-works/pi-coding-agent

# Bun
bun uninstall -g @earendil-works/pi-coding-agent

pi をアンインストールしても、~/.pi/agent/ 内の設定、認証情報、セッション、インストール済み pi パッケージは残ります。

作業させたいプロジェクトディレクトリで pi を起動します：

cd /path/to/project
pi

認証

Pi は /login 経由のサブスクリプションプロバイダー、または環境変数や auth ファイル経由の API キープロバイダーを使用できます。

オプション 1: サブスクリプションログイン

pi を起動して実行：

/login

プロバイダーを選択します。組み込みのサブスクリプションログインには Claude Pro/Max、ChatGPT Plus/Pro (Codex)、GitHub Copilot が含まれます。

オプション 2: API キー

pi を起動する前に API キーを設定：

export ANTHROPIC_API_KEY=sk-ant-...
pi

/login を実行して API キープロバイダーを選択し、キーを ~/.pi/agent/auth.json に保存することもできます。

サポートされているすべてのプロバイダー、環境変数、クラウドプロバイダーのセットアップは プロバイダー を参照してください。

最初のセッション

pi が起動したら、リクエストを入力して Enter を押します：

Summarize this repository and tell me how to run its checks.

デフォルトでは、pi はモデルに 4 つのツールを提供します：

• read - ファイルを読む
• write - ファイルを作成または上書き
• edit - ファイルをパッチ
• bash - shell コマンドを実行

追加の組み込み読み取り専用ツール（grep、find、ls）はツールオプション経由で利用できます。Pi は現在の作業ディレクトリで動作し、そこにあるファイルを変更できます。簡単にロールバックしたい場合は git や別のチェックポイントワークフローを使用してください。

pi にプロジェクト指示を与える

Pi は起動時にコンテキストファイルを読み込みます。AGENTS.md ファイルを追加して、プロジェクトでの作業方法を指示できます：

# Project Instructions

- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.

Pi は以下を読み込みます：

• グローバル指示用の ~/.pi/agent/AGENTS.md
• 親ディレクトリと現在のディレクトリからの AGENTS.md または CLAUDE.md

コンテキストファイルを変更した後は pi を再起動するか、/reload を実行してください。

よく試すこと

ファイルを参照する

エディターで @ を入力してファイルをあいまい検索するか、コマンドラインでファイルを渡します：

pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"

画像は Ctrl+V（Windows では Alt+V）で貼り付けるか、対応ターミナルにドラッグできます。

Shell コマンドを実行する

対話モードでは：

!npm run lint

コマンド出力はモデルに送信されます。!!command を使用すると、出力をモデルコンテキストに追加せずにコマンドを実行できます。

モデルを切り替える

/model または Ctrl+L でモデルを選択します。Shift+Tab で思考レベルを切り替えます。Ctrl+P / Shift+Ctrl+P でスコープ付きモデルを順に切り替えます。

後から続ける

セッションは自動保存されます：

pi -c                  # 直近のセッションを続行
pi -r                  # 過去のセッションを参照
pi --name "my task"    # 起動時にセッション表示名を設定
pi --session <path|id> # 特定のセッションを開く

pi 内では /resume、/new、/tree、/fork、/clone でセッションを管理できます。

非対話モード

ワンショットプロンプトの場合：

pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"

JSON イベント出力には --mode json、プロセス連携には --mode rpc を使用します。

次のステップ

• Pi の使い方 - 対話モード、スラッシュコマンド、セッション、コンテキストファイル、CLI リファレンス。
• プロバイダー - 認証とモデルセットアップ。
• 設定 - グローバルおよびプロジェクト設定。
• Keybindings - ショートカットとカスタマイズ。
• Pi パッケージ - 共有拡張機能、スキル、プロンプト、テーマのインストール。

プラットフォーム向けメモ：Windows、Termux、tmux、ターミナル設定、Shell エイリアス。