クイックスタート

手元のローカルリポジトリと、普段使っているエージェントから始めましょう。CLIは、Pathruleのインストールとターミナル操作を担う入り口です。macOS、Linux、Windows上で対応エージェントを接続し、同じワークスペースのナレッジにはVS Code拡張機能やMCP経由でもアクセスできます。オプションのオンデバイスモデルには、別途プラットフォーム要件があります。

まず小さなローカルプロジェクトで試したい場合は、サンプルワークスペースの手順に沿って進めてください。プロジェクトはご自身で作成し、編集します。

1. ランタイムのインストール

Node.js 20.11.1以降でCLIをインストールします。

npm i -g @pathrule/cli

• CLIは、ターミナル、SSH接続先、自動化の中でPathruleを動かします。詳しい要件はCLIのインストールを参照してください。
• VS Code拡張機能は、エディタ内でナレッジを閲覧・編集する機能を追加し、AIクライアントの接続にも使えます。Pathrule for VS Codeを参照してください。

どちらも同じワークスペースのナレッジに対して使えます。Cloudではアカウントを通じて両者がつながります。CLIをLocalで使う場合、アカウントは不要です。

2. サインイン

pathrule setupを実行すると、CloudかLocalかを選ぶよう求められます。Cloudでは、ワークスペースのナレッジを共有するためにサインインします。Localはアカウント不要です。pathrule setup --localを使うと、直接Localを選んでサインインを省略できます。両者の比較はローカルとCloudの選択を参照してください。セットアップを始めるには手順3に進みます。

Cloudの場合は、デスクトップ、SSH接続先、ヘッドレス環境のいずれでも、ワンタイムコードを使って個別にサインインすることもできます。

pathrule login

CLIがコードを表示し、そのコードが入力済みの状態で承認ページを開きます。マシンにブラウザがない場合は、表示されたURLを任意のデバイスで開き、コードを入力して承認してください。代わりにこのマシン上でブラウザのコールバックフローを使う場合は、pathrule login --browser-callbackを実行します。

どちらのフローでもサインインした状態になり、そのセッションはランタイムがバックグラウンドで更新し続けます。

3. ワークスペースの作成

ワークスペースは、Pathruleがコンテンツをスコープする単位です。手元のマシン上の1つのリポジトリ、または少数のリポジトリのまとまりに対応します。

CLIでは、すべての操作が実行したフォルダを対象に行われるため、まずリポジトリに移動してください。対話形式のセットアップでは、ワークスペースの作成または紐づけと、AIクライアントの接続を一度に行います。

cd ~/repos/my-team
pathrule setup

セットアップでは組織が表示され、一致するワークスペースを提案するか、このフォルダ用に新しく作成し、接続する対応AIクライアントを尋ねます。その後、エージェントが実行する初回のプロジェクトスキャンを提案することもあり、スキャンで提案されたメモリ、ルール、スキルを承認できます。アカウントなしでこのマシン上にワークスペースを保持する場合はpathrule setup --localを実行します。詳しくはローカルセットアップを参照してください。

Cloudを手動でセットアップする場合、pathrule initはフォルダ名を付けたワークスペースを作成し、フォルダをそこに紐づけます。既存のCloudワークスペースには、名前またはIDで紐づけます。

cd ~/repos/my-team
pathrule workspace attach my-team

パスを指定するオプションはありません。CLIは常に現在のフォルダを紐づけます。続いて、CLIのインストールで説明しているとおり、pathrule install <client>とpathrule syncでクライアントを接続します。ランタイムはこの対応付けを使って、現在のディレクトリをワークスペースに解決します。

4. 最初のメモリを書く

すべてが正しくつながっているかを確かめる一番の近道は、メモリを1つ書き、そのメモリが対象とするスコープでアシスタントを開くことです。このガイドでは、ワークスペースのルートに置きます。

Title: Our database is Postgres on Supabase
Body:
- All queries should treat row level security as the source of truth.
- Do not bypass RLS with a service key in user facing code.
- Migrations live in supabase/migrations and run through CI.

Cloudワークスペースであれば、ターミナルからコマンド1つでメモリを追加できます。--bodyを指定しない場合、CLIは本文を書くためにエディタ（VISUALまたはEDITOR）を開きます。--bodyを渡すか、テキストをパイプで渡すこともできます。

pathrule memory add --path / --title "Our database is Postgres on Supabase"

その後リポジトリでpathrule syncを実行し、クライアントが読み込むファイルとローカルインデックスに新しいメモリを反映させます。

VS Codeでは、PathruleビューのNew Memory… を使います。ローカルワークスペースでは、Local Consoleで書くか、PathruleのMCPツールを通じて保存するようエージェントに依頼してください。CLIはローカルのナレッジを一覧表示、閲覧、検索できますが、追加はできません。

5. フックの動作を確認する

ワークスペースに紐づけたディレクトリでClaude CodeまたはCodexを開きます。新しいターンを始め、メモリが扱う領域に関わる質問をしてみてください。

プロンプトを送信すると、Pathruleのフックがそのパスに対応するキャッシュ済みのスライスを読み込み、関連するメモリとルールを整形して、最初のツール呼び出しより前にエージェントへ渡します。エージェントが表示するコンテキストにメモリが現れ、タスクの途中で余分な往復は発生しません。

CursorとGitHub Copilotにはプロンプトフックがありません。Pathruleはセッションフックとツールフック、各クライアントの指示ファイル、MCPを通じてこれらに届きます。Windsurfにはフックがなく、セッション開始時にはルールファイルを、より深いコンテキストにはMCPを使います。これらのクライアントは、それぞれのガイドに沿って確認してください：Cursor、GitHub Copilot、Windsurf。

何も表示されない場合は、doctorを実行します。

pathrule doctor

doctorは、サインイン状態、ワークスペースとこのフォルダがそこに紐づいているかどうか、各AIクライアントのMCPエントリ、フォルダ内でPathruleが管理するファイルを確認し、対応が必要な項目には次に実行すべきコマンドを示します。古くなったクライアントのエントリはpathrule repairで修正できます。

6. ルールの追加

メモリは事実で、ルールは制約です。同じパスにルールを追加しましょう。Cloudワークスペースであれば、ターミナルから次のように実行します。

pathrule rule add --path / --name "No service key in browser code" --priority high --scope folder \
  --body "Never use the SUPABASE_SERVICE_ROLE_KEY in any file under apps/web. Use the anon key plus row level security."

VS Code拡張機能のNew Rule… を使うか、エージェントにルールの保存を依頼することもできます。

もう一度Claude Codeを開きます。ルールはメモリと一緒に届きます。優先度highにより、上位に近い優先順位が付きます。コンテキストとして届くルールは、エージェントに従うよう指示される要件であり、操作をブロックするものではありません。ルールには実行可能な制約を持たせることもできます。エージェントは制約を提案でき、提案は保存されますが強制はされません。人が承認して初めて、ツール実行前フックが一致する編集をブロックできるようになり、それもツールフックがその判断を尊重するクライアントに限られます。ガードレールとしてのルールを参照してください。

次に読むもの

• 基本概念：メモリ、ルール、スキルを支えるデータモデルについて。
• フックの仕組み：キャッシュとエージェントの間で何が起きているかを理解するために。
• MCPの概要：アシスタントがコンテンツの読み書きに使うツールについて。
• CLIコマンドリファレンス：Pathrule CLIの全コマンドについて。