本文へスキップ
Pathrule

ドキュメント

Pathrule CLI

ターミナルを主軸にしたPathruleのインターフェースです。スクリプトで扱え、SSHでも使いやすく、アカウントの有無を問わず利用でき、シェルから動かすエージェントのための完全なローカルランタイムを備えています。

このページの内容

Pathrule CLIは、Pathruleのインストールとターミナル操作を担うインターフェースです。npmで@pathrule/cliとしてApache-2.0ライセンスのもと公開されており、macOS、Linux、Windowsで動作し、ローカルMCPサーバー、ローカルキャッシュ、フックスーパーバイザーをシェル上でホストします。Claude Code、Codex、Cursor、Windsurf、GitHub Copilotを接続でき、SSH、ヘッドレス、単体のターミナルといったワークフローにも適しています。

コンテンツとMCPのコントラクトはクライアント間で共通ですが、配信方法は各クライアントが提供するチャネルに従います。Claude CodeとCodexにはプロンプトフックを含むフックが用意されるため、エージェントが動き出す前にコンテキストが届きます。CursorとGitHub Copilotにはセッションフックとツールフックが用意されますが、プロンプトフックはありません。Windsurfにはフックがなく、生成されたルールファイルを読み込み、より深いコンテキストにはMCP経由でアクセスします。

Pathrule CLIが担う役割

  • サインイン。 デフォルトはワンタイムのデバイスコードで、手元のコンピューター、SSH越し、任意のヘッドレスマシンのどこでも同じように使えます。--browser-callbackを付けると、このマシン上のブラウザコールバックを使ったGitHubサインインになります。
  • ワークスペースの紐づけ。 実行したフォルダをワークスペースに紐づけ、ランタイムがAIセッションの作業ディレクトリを解決できるようにします。pathrule setupはこれをガイド付きで行い、pathrule initはワークスペースの作成と紐づけを一度に行います。
  • AIクライアントのインストールと同期。 Claude Code、Codex、Cursor、Windsurf、GitHub CopilotにPathruleのMCPエントリを書き込みます。pathrule syncは、各クライアントが読み込む指示ファイルとフック設定をリポジトリに書き込みます。
  • 削除。 pathrule ejectはプロジェクトのクリーンアップ内容をプレビューし、pathrule eject --applyで実際に適用します。ネイティブ連携はpathrule integrations remove <agent>で、設定ベースのMCPエントリはpathrule uninstall <client>で削除します。詳しくはプロジェクトからPathruleを削除するを参照してください。
  • アカウント不要。 pathrule init --localとpathrule setup --localを使うと、サインインもCloudも使わず、ローカルストア上でPathruleを実行できます。詳しくはアカウントなしで使うを参照してください。
  • オンデバイスモデル。 pathrule intelligenceは、Apple Silicon搭載Mac向けのオプションのオンデバイスモデルをインストール、更新、削除します。ほかの機能はこのモデルに依存しません。詳しくはローカルモデルを参照してください。
  • MCPサーバー。 ローカルで動作し、アシスタントが通信する窓口になります。
  • フックスーパーバイザー。 フックに対応した各クライアントがサポートするフックを登録し、エージェントが作業しているフォルダに応じたパス単位のコンテキストを届けます。
  • 作業の好み。 pathrule meは、User Intelligenceがあなたについて保持している内容(手元のマシンに保存)の一覧表示、教え込み、説明、スコープ変更、削除を行います。pathrule me contextは、あるタスクに対してエージェントが受け取る内容を表示します。
  • ターミナルでのナレッジ操作。 pathrule search、list、readはLocalとCloudの両方で使えます。CLIのaddはCloudワークスペース向けで、ローカルでの作成にはLocal Console、VS Code、MCPを使います。
  • Doctor。 サインイン、ワークスペースとフォルダの紐づけ、各AIクライアントのMCPエントリ、フォルダ内でPathruleが管理するファイルをチェックする、読み取り専用の単一コマンドです。古くなったエントリはpathrule repairで修正します。
  • スクリプト対応。 ほぼすべてのコマンドが--jsonを受け付け、安定した機械可読の出力を返します。

すべてのコマンドとオプションはコマンドリファレンスにまとめています。

基本の流れ

pathrule login
pathrule org use my-team
cd ~/repos/my-project
pathrule setup
pathrule doctor

pathrule setupは、フォルダを一致するワークスペースに紐づけるか新しく作成し、接続するAIクライアントを尋ね、それらをインストールして、クライアントが読み込むファイルを書き込みます。ワークスペースを自分で作成する場合は、フォルダ内でpathrule init my-projectを実行します。既存のワークスペースに紐づける場合はpathrule workspace attach my-projectを使います。どちらも現在のフォルダを対象に動作し、パスを指定するオプションはありません。

これ以降、~/repos/my-projectで開いたClaude CodeやCodexは、最初のプロンプトの時点でPathruleのコンテキストを受け取ります。CursorとGitHub Copilotはセッション開始時とツール呼び出しの前後に受け取り、Windsurfはルールファイルから、またMCP経由で読み込みます。

出力モード

CLIには2つの出力モードがあり、--jsonで切り替えます。

  • ヒューマンモード(デフォルト): ok、warn、error、infoのいずれかが付いたステータス行を表示し、該当する場合は次に実行すべきコマンドも示します。プロンプトやブラウザウィンドウは、対話型ターミナルでのみ表示されます。
  • JSONモード: コマンドごとに1つのJSONオブジェクトを出力し、スクリプト、CIランナー、自動化処理に向いています。常にok、command、cwdを含み、成功時はdata、失敗時はcodeとmessageを持つerrorが加わります。--jsonは、--helpでこのオプションを表示するコマンドで利用できます。snapshotとejectは対応していません。このモードではプロンプトを出したりブラウザを開いたりすることはありません。
pathrule workspace list           # human
pathrule workspace list --json    # machine readable

指示どおりの処理ができなかった場合、コマンドは0以外の終了コードで終了するため、CIのステップは失敗として扱われます。

ブラウザを開くコマンド

一部のフローはCloud専用で、ターミナル上にコンソールを再実装する代わりに、デフォルトブラウザでPathrule Webを開きます。

pathrule billing
pathrule upgrade
pathrule team open

いずれも開いたURLを出力します。--no-openを付けると何も開かずにURLだけを出力するので、リモートシェルからコピーできます。オプションなしのpathrule teamは、組織のメンバーと保留中の招待をターミナルに一覧表示します。

Pathrule CLIが向いている場面

SSH越しに作業するとき、CIランナーにPathruleをスクリプトで組み込みたいとき、アカウントなしでPathruleを試したいとき、あるいは普段からターミナル中心で作業しているときは、Pathrule CLIを使ってください。エディタ内でナレッジを閲覧、編集したい場合は、同じサインインとフックを共有するPathrule for VS Codeを追加しましょう。