クイックスタート

このページでは、インストールから最初に使える pi セッションを開始するまでを説明します。

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

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

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

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

# curl installer or 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 パッケージは ~/.pi/agent/ に残ります。

次に、pi に作業させたいプロジェクトディレクトリで起動します。

cd /path/to/project
pi

Pi は /login 経由でサブスクリプション Provider を使用できます。API key Provider は、環境変数または auth ファイル経由で使用できます。

pi を起動して実行します。

/login

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

pi を起動する前に API key を設定します。

export ANTHROPIC_API_KEY=sk-ant-...
pi

/login を実行して API key Provider を選択し、key を ~/.pi/agent/auth.json に保存することもできます。

サポートされているすべての Provider、環境変数、cloud provider の設定については Providers を参照してください。

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

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

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

• read - ファイルを読み取る
• write - ファイルを作成または上書きする
• edit - patch でファイルを変更する
• bash - Shell コマンドを実行する

追加の組み込み read-only ツール（grep、find、ls）は、ツールオプションで有効にできます。Pi は現在の作業ディレクトリで実行され、そこにあるファイルを変更できます。簡単に戻せるようにしたい場合は、Git などの checkpoint workflow を使用してください。

Pi は起動時に context files を読み込みます。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

ディレクトリに AGENTS.override.md が含まれている場合、Pi はそのディレクトリの AGENTS.md または CLAUDE.md の代わりにそれを読み込みます。

context files を変更した後は、pi を再起動するか /reload を実行してください。

エディタで @ を入力するとファイルを fuzzy search できます。コマンドラインでファイルを渡すこともできます。

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

画像やテキストは Ctrl+V（Windows では Alt+V）で貼り付けられます。対応するターミナルでは画像をドラッグすることもできます。

インタラクティブモードでは次のように入力します。

!npm run lint

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

モデルを選択するには /model または Ctrl+L を使用します。thinking level を切り替えるには Shift+Tab を使用します。scoped models を切り替えるには Ctrl+P / Shift+Ctrl+P を使用します。

セッションは自動的に保存されます。

pi -c                  # Continue most recent session
pi -r                  # Browse previous sessions
pi --name "my task"    # Set session display name at startup
pi --session <path|id> # Open a specific session

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

一回限りの Prompt には次を使います。

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

JSON event output には --mode json、プロセス連携には --mode rpc を使用します。

• Using Pi - インタラクティブモード、slash commands、セッション、context files、CLI リファレンス。
• Providers - 認証とモデル設定。
• Settings - グローバル設定とプロジェクト設定。
• Keybindings - ショートカットとカスタマイズ。
• Pi Packages - 共有 Extensions、Skills、Prompts、Themes のインストール。

プラットフォーム別メモ: Windows、Termux、tmux、Terminal setup、Shell aliases。