Pathruleコマンドリファレンス
Pathrule CLIの全コマンドについて、機能と押さえておくべきオプションをまとめています。サインインやワークスペースのセットアップから、ナレッジ、診断、アカウントなしのローカル利用まで扱います。
このページの内容
Pathrule CLIの全コマンドを、pathrule helpと同じグループ分けで紹介します。各項目では、コマンドの機能と押さえておくべきオプションを説明しています。初めてセットアップする場合は、インストールから始めてください。
pathrule <command> [subcommand] [arguments] [options]
pathrule help
グローバルオプション
| オプション | 機能 |
|---|---|
--json | 人間向けの出力ではなく、機械可読なJSONオブジェクトを1つ出力します。あわせて色、プロンプト、ブラウザウィンドウも無効になります。 |
--yes | setupとcache pruneが変更を加える前に求める確認を承認します。 |
--no-open | ブラウザを一切開きません。ブラウザを開くはずのコマンドは、代わりにURLを出力します。 |
--no-color | 色なしのプレーンな出力にします。環境変数NO_COLORを1に設定しても同じです。 |
--local | init、setup、sync、searchと、memory、rule、skillの各コマンドを、アカウント不要のローカルストアに対して実行します。アカウントなしで使うを参照してください。 |
--help, -h | コマンド一覧を出力します。 |
--version, -v | CLIのバージョンを出力します。 |
環境変数CIがtrueの場合も、CLIはプロンプトとブラウザウィンドウを省略します。そのため、ランナー上でコマンドが入力待ちになることはありません。
コマンドが認識しないオプション
CLIは認識できないオプションを拒否しません。ほとんどのコマンドはそれを通常の引数として扱うため、コマンドが失敗するか、意図しない対象に作用します。pathrule workspace attach --path ~/repos/appは--pathという名前のワークスペースを探し、pathrule install --client cursorは--clientがクライアント名ではないため停止します。setup、invite、team、およびmemory add、rule add、skill addは自身のオプションを検証し、認識できないオプションがあるとエラーで停止します。このページまたはpathrule helpに記載されたオプションを使ってください。
JSON出力
--jsonを付けると、すべての応答はok、command、cwdを含む1つのJSONオブジェクトになります。コマンドが成功した場合はdataが、失敗した場合はcodeとmessageを持つerrorが加わります。応答によっては、次に実行すべきコマンドを示すnext_stepsが追加されます。--jsonは、--helpで対応が示されているコマンドで使えます。snapshotとejectは対応していないため、これらは付けずに実行してください。サインインはプレーンなpathrule loginで行ってください。サインインのフローではコードを表示する必要があるためです。
終了コード
0は、コマンドが指示どおりに完了したことを示します。引数の不足や不明なクライアント名など、使い方の誤りの多くは64で終了します。それ以外の失敗は1で終了し、pathrule doctorもチェックに失敗すると1で終了します。Node.jsのバージョンが20.11.1より古い場合、すべてのコマンドは何も実行せずに78で停止します。
はじめる
| コマンド | 機能 |
|---|---|
pathrule setup | 対話形式のガイドに沿って、1回の実行で現在のフォルダを接続します。必要に応じてサインインし、組織内でこのフォルダに一致するワークスペース（同じgitリモートなど）を提案し、選んだワークスペースを接続するか、フォルダ名を付けたワークスペースを作成します。続いて接続するAIクライアントを尋ねてインストールし、それらが読み込むファイルを書き出したうえで、いずれかのクライアントで最初のプロジェクトスキャンを開始するよう提案します。Apple Silicon Macでは、最後にオプションのオンデバイスモデルを提案します。 |
pathrule init [name] | 現在の組織にワークスペースを作成し、現在のフォルダを接続します。名前を指定しない場合は、フォルダ名がワークスペース名になります。 |
プロンプトを表示できるターミナルがない場合、pathrule setupは計画を出力するだけです。出力されるのは、組織、一致するワークスペース、そして最適なワークスペースを接続するコマンドです。以下のオプションを使うと実際に処理を行いますが、その場合は--yesが必要です。
--workspace <name-or-id>は既存のワークスペースを接続します。--workspace-idも同じオプションです。--create-workspaceはフォルダ名を付けたワークスペースを作成します。名前を自分で付けるには--workspace-name <name>を追加します。--select-workspace <name-or-id>は、このフォルダを接続せずにワークスペースをカレントにします。--org <slug-or-id>は、先に組織を切り替えます。--target <client>は、claude、cursor、codex、windsurf、copilot、またはallのMCPエントリをインストールします。
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerunは、リポジトリのドキュメントとコミット履歴を再スキャンし、現在のワークスペースの最初のプロジェクトスキャン用に、新しいメモリとルールの候補を用意します。
アカウントとコンテキスト
| コマンド | 機能 |
|---|---|
pathrule login | ワンタイムコードでサインインします。CLIはコードを出力し、コードが入力済みの承認ページをブラウザで開きます。ブラウザがない場合は、任意のデバイスで開けるURLを出力します。--no-openを付けるとブラウザを一切開きません。--browser-callbackはこのマシンのブラウザでGitHubを使ってサインインし、ローカルのコールバックを介して戻ります。それができない場合はコードによる方式にフォールバックします。--device-codeも受け付け、デフォルトのコードフローを実行します。 |
pathrule logout | このマシンでPathrule CLIからサインアウトします。--allを付けると、VS Code拡張機能など、このマシン上の他のPathruleサーフェスからもサインアウトします。 |
pathrule whoami | サインイン中のアカウントと、セッションの有効期限を表示します。 |
pathrule org list | 所属する組織を自分のロールとともに一覧表示し、現在の組織に*を付けます。引数なしのpathrule orgでも同じです。 |
pathrule org current | 現在の組織と、その組織での自分のロールを表示します。 |
pathrule org use <slug-or-id> | 現在の組織を切り替えます。 |
pathrule workspace list | 現在の組織のワークスペースを一覧表示し、現在のワークスペースに*を付けます。引数なしのpathrule workspaceでも同じです。 |
pathrule workspace current | 現在のワークスペースを表示します。 |
pathrule workspace use <name-or-id> | フォルダを接続せずにワークスペースをカレントにします。 |
pathrule workspace create <name> | ワークスペースを作成し、現在のフォルダを接続します。 |
pathrule workspace attach [name-or-id] | 現在のフォルダを既存のワークスペースに接続します。ワークスペースは名前の完全一致またはIDで指定します。引数を省略すると、現在のワークスペースを接続します。パスを指定するオプションはないため、対象のフォルダ内で実行してください。 |
pathrule workspace detach [name-or-id] | このマシン上でのワークスペースとフォルダの接続を解除します。ワークスペースとその内容はPathruleに残ります。 |
pathrule workspace inspect | 現在のワークスペースの詳細を表示します。所属する組織とプラン、接続先、gitリモート、保持しているメモリ、ルール、スキルの数、プランの使用状況、セットアップ済みのAIクライアント、最近のアクティビティが含まれます。 |
接続、作成、init、workspace useを行うと、そのワークスペースがカレントにもなります。memory、rule、skill、search、syncなどのコマンドは、現在のワークスペースに対して動作します。
ワークスペースのセットアップ
| コマンド | 機能 |
|---|---|
pathrule attach [name-or-id] | workspace attachと同じです。 |
pathrule detach [name-or-id] | workspace detachと同じです。 |
pathrule install [client] | AIクライアント自身のユーザーレベル設定にPathruleのMCPサーバーエントリを書き込みます。設定内の他のサーバーには一切手を加えません。クライアントにはclaude(またはclaude-code)、cursor、codex、windsurf、copilot(またはgithub-copilot)、またはall（デフォルト）を指定できます。GitHub Copilotには、Copilot CLI用とVS Code用の2つのエントリが書き込まれます。 |
pathrule uninstall [client] | 指定したクライアント、または5つすべてのクライアントの設定から、PathruleのMCPエントリを削除します。 |
pathrule sync | AIクライアントが読み込むファイル（指示ファイル、フック設定、ローカルのフックインデックス）をリポジトリに書き出します。ワークスペースが接続されているフォルダで実行してください。--skillsは、ワークスペースのスキルだけを各クライアントのスキルフォルダに同期します。--localはアカウント不要のワークスペースを同期します。 |
pathrule mcp run | PathruleのローカルMCPサーバーを標準入出力で起動します。pathrule installが書き込むMCPエントリが起動するのはこのコマンドです。AIクライアントが実行するため、自分で実行する必要はありません。 |
pathrule syncは、pathrule setupでこのワークスペース用に選んだAIクライアント向けのファイルを書き出します。選ばれたクライアントがない場合は、Pathruleのファイルがすでにリポジトリにあるクライアント向けに書き出し、それもなければClaude Code向けに書き出します。Claude CodeのCLAUDE.mdとフックのエントリは、同期のたびに更新されます。各ファイルの一覧はインストールを参照してください。リポジトリからPathruleを取り除くには、プロジェクトからPathruleを削除するを参照してください。
ナレッジ
| コマンド | 機能 |
|---|---|
pathrule search <query> | 現在のワークスペースのメモリ、ルール、スキルを検索します。--type memory,ruleで種類を絞り込み、--path /apps/apiでパスを絞り込み、--limit <n>で結果の件数を制限します。 |
pathrule memory list | メモリを一覧表示します。--pathまたは先頭に置いたパスで一覧を絞り込めるため、pathrule memory list /apps/apiとpathrule /apps/api memory listは同じ意味になります。--limit <n>で件数を制限します。 |
pathrule memory read <id-or-title> | メモリを出力します。長い内容をターミナルで全文表示するには--printを付けます。 |
pathrule memory add | --path </node/path> --title <title>でメモリを書き込みます。本文は--bodyまたは標準入力から取得し、どちらも指定しない場合はエディタ(VISUALまたはEDITOR)で入力します。--allow-duplicateは重複チェックを省略します。 |
pathrule rule list, read, add | ルールに対して同じ操作を行います。rule addは--titleの代わりに--nameを取り、さらに--priority(high、medium、lowのいずれか、デフォルトはmedium)と--scope(project、folder、file_typeのいずれか、デフォルトはproject)を指定できます。 |
pathrule skill list, read, add | スキルに対して同じ操作を行います。skill addは--nameと、任意の--descriptionを取ります。 |
pathrule refresh list | 未処理のリフレッシュタスク（古くなったナレッジの更新リクエスト）を一覧表示します。--include-in-progressで取得済みのタスクも含め、--limit <n>で件数を制限します。 |
pathrule refresh claim [id] | リフレッシュタスクを取得し、その概要を出力します。IDを指定しない場合は、次の未処理タスクを取得します。 |
pathrule refresh resolve <id> --status applied | リフレッシュタスクをappliedまたはrejectedとしてクローズします。--note "<text>"で理由を記録します。 |
pathrule snapshot | 現在のフォルダの概要（ファイルツリー、マニフェスト、短いドキュメントのサンプル、gitブランチ、最近の履歴）を取得し、ワークスペースにアップロードします。それ以外のファイル内容は読み取りません。--dry-runはアップロードせずに内容を出力し、--notes "<text>"はメモを添付します。 |
pathrule snapshot list [n] | ワークスペースの最近のスナップショットを一覧表示します。 |
作業の好みとローカルモデル
| コマンド | 機能 |
|---|---|
pathrule me list | User Intelligenceが把握しているあなたの作業スタイルを、使用中のものとまだ使用されていないものの両方について一覧表示します。引数なしのpathrule meでも同じです。 |
pathrule me teach "<sentence>" | 好みを自分の言葉で教えます。オプションのオンデバイスモデルが必要です。 |
pathrule me explain <id> | 1つの好みを、その根拠とともに表示します。IDはme listが出力する短いIDです。 |
pathrule me scope <id> | 好みの適用範囲を、コマンドを実行したワークスペースに限定します。--everywhereを付けると、すべてのワークスペースで適用されます。 |
pathrule me forget <id> | 好みの使用を停止し、却下済みとして保持します。これにより、同じ根拠から再び採用されることはありません。--deleteを付けると完全に削除します。 |
pathrule me context "<task>" | そのタスクでエージェントが受け取る内容と、除外された好みおよびその理由を出力します。 |
pathrule intelligence status | オンデバイスモデルがインストールされているか、そのバージョン、アップデートの有無を表示します。引数なしのpathrule intelligenceでも同じです。 |
pathrule intelligence install | モデルに必要なローカルランタイムをセットアップしてからモデルをダウンロードし、有効化する前にチェックサムを検証します。Apple Silicon Macが必要です。 |
pathrule intelligence update | 新しいモデルがある場合にインストールします。アップデートに失敗した場合は、それまでのモデルがそのまま残ります。 |
pathrule intelligence remove | モデルを削除します。モデルを必要としない機能は、これまでどおり動作します。 |
Local Consoleとエージェント連携
| コマンド | 機能 |
|---|---|
pathrule ui | ナレッジ、アクティビティ、Local Signalsを扱う、アカウント不要のLocal Consoleを開きます。--port、--no-open、--jsonで開き方を制御します。 |
pathrule integrations | Claude CodeとCodexの対話型セットアップです。対話型ターミナル以外では、セットアップ内容を一覧表示します。 |
pathrule integrations add claude codex --local --dry-run | ネイティブ連携を、書き込みを行わずにプレビューします。Cloudモードにするには--cloudを選びます。 |
pathrule integrations list | 検出されたエージェントと、記録済みの連携を一覧表示します。 |
pathrule integrations doctor | インストール済みの連携を読み取り専用でチェックします。 |
pathrule integrations repair | 記録済みのPathrule連携を再適用します。 |
pathrule integrations remove <agent> | 記録済みの連携を削除します。 |
pathrule telemetry | テレメトリの設定と、このCLIが送信できる状態かどうかを表示します。 |
pathrule telemetry enable | サインイン済みのマネージドCLIで、匿名の利用状況イベントの送信にオプトインします。 |
pathrule telemetry disable | 送信を無効にします。 |
Local Consoleとネイティブエージェント連携を参照してください。
プロジェクト連携の削除
pathrule ejectは、現在のリポジトリでPathruleが管理しているファイルと管理領域を削除する計画を、読み取り専用で表示します。内容を確認したうえでpathrule eject --applyを実行すると、計画が実行されます。ejectには--json形式はありません。ネイティブプラグインはpathrule integrations remove <agent>で削除します。
診断とメンテナンス
| コマンド | 機能 |
|---|---|
pathrule status | サインイン中のアカウント、現在の組織とプラン、現在のワークスペース、このフォルダが接続されているかどうかを表示します。 |
pathrule doctor | 読み取り専用のチェックを実行します。対象は、サインイン、組織、ワークスペース、このフォルダが接続されているか、各AIクライアントにPathruleのMCPエントリがあるか、そしてこのフォルダでPathruleが管理しているファイル（それぞれを書き出したサーフェスとバージョンを含む）です。対応が必要な項目があれば、次に実行すべきコマンドを示します。--jsonを付けると、レポートにNode.jsのバージョンも含まれ、起動コマンドが古くなっているMCPエントリが指摘されます。--bundleは、認証情報とローカルパスを伏せたサポート用ファイルを書き出します。 |
pathrule repair | AIクライアントの設定にある古いPathruleのMCPエントリを、他のサーバーには手を加えずに書き直し、リポジトリのファイルを再度書き出して、変更内容を報告します。 |
pathrule preflight <action> | 実行する前に、そのアクションがプランで許可されているかを確認します。アクションはcreate_workspace、write_memory、write_rule、write_skill、sync_agents、materialize_skillsのいずれかです。 |
pathrule cache prune | 古くなったローカルのキャッシュフォルダを、削除せずに一覧表示します。--yesを付けると削除します。 |
pathrule config get <key> | 設定を読み取ります。キーはupdate.policy、telemetry.enabled、telemetry.idのいずれかです。 |
pathrule config set <key> <value> | update.policy manualは毎日のアップデート確認を停止し、notifyとautoは確認を継続します。telemetry.enabled falseは匿名の利用状況テレメトリを無効にします。環境変数NO_TELEMETRYを1に設定すると、1回の実行またはそのシェルで同じ効果が得られます。 |
pathrule config reset telemetry-id | テレメトリIDを新しいものに置き換えます。 |
pathrule update | 新しいCLIがあるかを確認し、インストール用のコマンドを出力します。自分で何かをインストールすることはありません。 |
対話型で実行した場合、1日に1回、新しいCLIがあるかも確認し、アップグレード用のコマンドを含む1行の通知を出力します。通知されるのは、現在のバージョンより新しいバージョンだけです。
スタンドアロンのローカルCLIはテレメトリを送信しません。サインイン済みのマネージドCLIは、pathrule telemetry enableでオプトインした場合にのみ、匿名の利用状況イベントを送信します。イベントには、コード、パス、プロンプト、ナレッジ、メールアドレス、アカウントIDやワークスペースIDは含まれません。無効にするにはpathrule telemetry disableを実行します。NO_TELEMETRY=1、DO_NOT_TRACK=1、CI環境では無効のままになります。
チームと請求
| コマンド | 機能 |
|---|---|
pathrule team | 現在の組織、または--org <slug-or-id>で指定した組織のメンバーと保留中の招待を一覧表示します。pathrule team openは、メンバーを管理するPathrule Webを開きます。 |
pathrule invite <email> | チームメイトを現在の組織にEditorとして招待します。--roleでadmin、editor、viewerのいずれかを設定し、--orgと--workspaceで組織とワークスペースを指定します。招待メールが送信されたかどうかと、招待によってシート数がどう変わるかを報告します。 |
pathrule billing | Pathrule Webで組織の請求ページを開きます。 |
pathrule upgrade | プランを選ぶための請求ページを開きます。 |
ヘルプとバージョン
| コマンド | 機能 |
|---|---|
pathrule help | コマンド一覧を出力します。 |
pathrule version | CLIのバージョンを出力します。--versionと同じです。 |
アカウントなしで使う
Pathrule CLIは、アカウントもCloudも使わずにローカルストアで動作します。プロジェクト内で次のコマンドを実行してください。
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name]は、現在のフォルダ用のローカルワークスペースをこのマシン上に作成します。そのフォルダをすでにカバーしているワークスペースがある場合は、それを再利用します。pathrule setup --localは同じ処理を行ったうえで、すべてのAIクライアント(--target <client>を付けた場合はそのクライアントのみ)にローカルのMCPエントリをインストールし、フックをインストールしてリポジトリのファイルを書き出します。いずれもサインインは不要です。--workspace-name <name>で新しいワークスペースに名前を付けます。--orgや--workspaceなど、アカウントを必要とするオプションはエラーで停止します。
ローカルワークスペースでは、AIエージェントがPathruleのMCPツールを使ってメモリ、ルール、スキルを書き込みます。ターミナルからは--localを付けて読み取りや検索を行います。
pathrule memory list --local
pathrule rule read "No service key in browser code" --local
pathrule search "migrations" --local
pathrule sync --local
memory add、rule add、skill addにはアカウントが必要です。--localを付けて実行すると、アカウントが必要である旨を表示し、何も変更しません。ローカルエディションに含まれる内容については、オープンソースのコアを参照してください。
次に読むもの
- インストール：初回のセットアップ、Pathruleがリポジトリに書き出す内容、その削除方法について説明しています。
- Pathrule CLI：CLIが担う役割と、どのような場面で使うかについて説明しています。
- User Intelligence：
pathrule meが管理する内容について説明しています。