クイックスタート

このページでは、インストールから便利な最初の pi セッションまでを説明します。

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

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

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

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 は、環境変数または認証ファイルを通じて subscription providers から /login、または API キープロバイダーを使用できます。

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

/login

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

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

export ANTHROPIC_API_KEY=sk-ant-...
pi

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

サポートされているすべてのプロバイダー、環境変数、クラウド プロバイダーの設定については、「Providers」を参照してください。

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

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

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

• read - ファイルの読み取り
• write - ファイルを作成または上書きします
• edit - パッチファイル
• bash - シェルコマンドを実行します

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

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 を実行します。

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

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 を使用してモデルを選択します。 Shift+Tab を使用して思考レベルを切り替えます。 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 を使用してセッションを管理します。

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

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 を使用します。

• Using Pi - インタラクティブ モード、slash commands、セッション、context files、および CLI リファレンス。
• Providers - 認証とモデルのセットアップ。
• Settings - グローバル構成とプロジェクト構成。
• Keybindings - ショートカットとカスタマイズ。
• Pi Packages - 共有拡張機能、スキル、プロンプト、テーマをインストールします。

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