Zum Inhalt springen
Pathrule

doku

Pathrule CLI

Die Terminal-Oberfläche von Pathrule. Skriptfähig, SSH-tauglich, mit oder ohne Konto nutzbar und eine vollständige lokale Runtime für Agents, die du aus einer Shell steuerst.

Auf dieser Seite

Pathrule CLI ist die Installations- und Terminal-Oberfläche von Pathrule. Sie wird auf npm als @pathrule/cli unter der Apache-2.0-Lizenz veröffentlicht, läuft auf macOS, Linux und Windows und betreibt den lokalen MCP-Server, den lokalen Cache und den Hook-Supervisor in deiner Shell. Sie verbindet Claude Code, Codex, Cursor, Windsurf und GitHub Copilot und passt zu SSH-, Headless- und reinen Terminal-Workflows.

Inhalte und MCP-Vertrag sind für alle Clients gleich, die Auslieferung richtet sich nach dem Kanal, den der jeweilige Client anbietet. Claude Code und Codex bekommen Hooks inklusive eines Prompt-Hooks, sodass der Kontext ankommt, bevor der Agent handelt. Cursor und GitHub Copilot bekommen Session- und Tool-Hooks, aber keinen Prompt-Hook. Windsurf hat keine Hooks: Es liest eine generierte Regeldatei und holt sich tieferen Kontext über MCP.

Wofür Pathrule CLI zuständig ist

  • Anmeldung. Standardmäßig ein einmaliger Gerätecode, der auf deinem eigenen Rechner, über SSH und auf jeder Headless-Maschine gleich funktioniert, oder die Anmeldung mit GitHub über einen Browser-Callback auf diesem Rechner mit --browser-callback.
  • Workspace-Anbindung. Bindet den Ordner, in dem du sie ausführst, an einen Workspace an, damit die Runtime das Arbeitsverzeichnis deiner KI-Session auflösen kann. pathrule setup erledigt das geführt, pathrule init legt einen Workspace an und bindet ihn in einem Schritt an.
  • Installation und Sync der KI-Clients. Schreibt den MCP-Eintrag von Pathrule in Claude Code, Codex, Cursor, Windsurf und GitHub Copilot. pathrule sync schreibt die Anweisungsdateien und die Hook-Konfiguration, die jeder Client liest, ins Repository.
  • Entfernen. pathrule eject zeigt eine Vorschau der Projektbereinigung, pathrule eject --apply führt sie aus. Native Integrationen entfernst du mit pathrule integrations remove <agent>, einstellungsbasierte MCP-Einträge mit pathrule uninstall <client>. Siehe Pathrule aus einem Projekt entfernen.
  • Kein Konto nötig. pathrule init --local und pathrule setup --local betreiben Pathrule mit einem lokalen Speicher, ohne Anmeldung und ohne Cloud. Siehe Ohne Konto arbeiten.
  • Das On-Device-Modell. pathrule intelligence installiert, aktualisiert und entfernt das optionale On-Device-Modell auf einem Mac mit Apple Silicon. Sonst hängt nichts davon ab. Siehe das lokale Modell.
  • MCP-Server. Läuft lokal und ist die Schnittstelle, mit der dein Assistent spricht.
  • Hook-Supervisor. Registriert die Hooks, die jeder hookfähige Client unterstützt, und liefert den pfadbezogenen Kontext für den Ordner, in dem der Agent gerade arbeitet.
  • Deine Arbeitsvorlieben. pathrule me listet auf, was User Intelligence über dich speichert, bringt ihr Neues bei, erklärt Einträge, ändert ihren Geltungsbereich und vergisst sie; alles bleibt auf deinem Rechner. pathrule me context zeigt, was ein Agent für eine Aufgabe erhalten würde.
  • Wissen im Terminal. pathrule search, list und read funktionieren im lokalen Modus und in der Cloud. add in der CLI ist für Cloud-Workspaces gedacht; lokal erstellst du Inhalte über die Local Console, VS Code oder MCP.
  • Doctor. Ein einzelner, rein lesender Befehl, der deine Anmeldung, die Workspace- und Ordneranbindung, den MCP-Eintrag jedes KI-Clients und die von Pathrule verwalteten Dateien im Ordner prüft. pathrule repair korrigiert veraltete Einträge.
  • Skripte. Fast jeder Befehl akzeptiert --json für stabile, maschinenlesbare Ausgabe.

Alle Befehle und Optionen findest du in der Befehlsreferenz.

Der Standardweg

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

pathrule setup bindet den Ordner an einen passenden Workspace an oder legt einen an, fragt, welche KI-Clients verbunden werden sollen, installiert sie und schreibt die Dateien, die sie lesen. Willst du den Workspace selbst anlegen, führe im Ordner pathrule init my-project aus, oder pathrule workspace attach my-project für einen bereits bestehenden. Beide wirken auf den aktuellen Ordner, und keiner von beiden akzeptiert eine Pfadoption.

Danach erhält Claude Code oder Codex, geöffnet in ~/repos/my-project, den Pathrule-Kontext schon für den ersten Prompt. Cursor und GitHub Copilot erhalten ihn beim Start der Session und rund um Tool-Aufrufe, Windsurf liest ihn aus seiner Regeldatei und über MCP.

Ausgabemodi

Die CLI hat zwei Ausgabemodi, zwischen denen du mit --json wechselst.

  • Menschenlesbarer Modus (Standard): Statuszeilen, markiert als ok, warn, error oder info, und gegebenenfalls mit dem nächsten auszuführenden Befehl. Rückfragen und Browserfenster erscheinen nur in einem interaktiven Terminal.
  • JSON-Modus: Ein JSON-Objekt pro Befehl, für Skripte, CI-Runner und Automatisierung. Es enthält immer ok, command und cwd, dazu data bei Erfolg oder einen error mit code und message. --json gibt es bei den Befehlen, die es in --help ausweisen. snapshot und eject unterstützen es nicht, und im JSON-Modus gibt es nie Rückfragen und es öffnet sich kein Browser.
pathrule workspace list           # human
pathrule workspace list --json    # machine readable

Ein Befehl beendet sich mit einem Exit-Code ungleich null, wenn er nicht getan hat, worum du ihn gebeten hast, sodass ein CI-Schritt daran scheitert.

Befehle, die den Browser öffnen

Einige Abläufe gibt es nur in der Cloud. Statt die Konsole im Terminal nachzubauen, öffnen sie Pathrule Web in deinem Standardbrowser.

pathrule billing
pathrule upgrade
pathrule team open

Jeder davon gibt die geöffnete URL aus. Mit --no-open wird nur die URL ausgegeben, ohne etwas zu öffnen, sodass du sie aus einer entfernten Shell kopieren kannst. Ein einfaches pathrule team listet die Mitglieder und offenen Einladungen der Organisation im Terminal auf.

Wann du Pathrule CLI nutzt

Nutze Pathrule CLI, wenn du über SSH arbeitest, Pathrule per Skript in einen CI-Runner einbinden willst, Pathrule ohne Konto ausprobieren möchtest oder einfach im Terminal zu Hause bist. Wenn du Wissen in deinem Editor durchsuchen und bearbeiten willst, ergänze Pathrule für VS Code, das dieselbe Anmeldung und dieselben Hooks verwendet.

  • Installation für Installationswege, die Anmeldeabläufe, was Pathrule in ein Repository schreibt und wie du es wieder entfernst.
  • Befehlsreferenz für alle Befehle und Optionen.
  • Pathrule für VS Code für die Editor-Oberfläche, die dieselbe Identität und dieselben Hooks nutzt.
  • So funktionieren Hooks dafür, was die Runtime an deinen Assistenten übergibt.