Installation

Pathrule CLI ist die terminalorientierte Oberfläche von Pathrule. Es wird auf npm als @pathrule/cli unter der Apache-2.0-Lizenz veröffentlicht und betreibt den lokalen MCP-Server, den Hook-Supervisor und den lokalen Cache für die Agents, die du aus einer Shell heraus steuerst. Diese Seite beschreibt die Installation, die Anmeldung, das Verbinden eines Repositorys und deiner KI-Clients, die Nutzung ohne Konto und das spätere Entfernen aus einem Projekt. Alle Befehle findest du in der Befehlsreferenz.

Voraussetzungen

• macOS, Linux oder Windows.
• Node.js 20.11.1 oder neuer. Die CLI prüft die Version bei jedem Aufruf und bricht bei einer älteren Version mit einer klaren Meldung ab.
• Eine aktuelle Shell: zsh, bash oder fish, unter Windows PowerShell.
• Ein KI-Coding-Assistent, der MCP spricht. Pathrule CLI verbindet Claude Code, Codex, Cursor, Windsurf und GitHub Copilot. Für die Installation optional, aber um den Hook-Ablauf zu prüfen, brauchst du einen.

Installieren

npm (macOS, Linux, Windows)

npm ist auf allen drei Betriebssystemen der Installationsweg. Es setzt Node.js 20.11.1 oder neuer voraus.

npm install -g @pathrule/cli

Unter Windows führst du das in PowerShell aus. Pathrule registriert automatisch einen Windows-kompatiblen Hook-Befehl, sodass dieselben pathrule-Befehle dort genauso funktionieren wie in einer Unix-Shell.

Zum Aktualisieren führst du dieselbe Installation mit @latest aus:

npm install -g @pathrule/cli@latest

Einmal am Tag prüft ein interaktiver Aufruf, ob es ein neueres Release gibt, und gibt einen einzeiligen Hinweis mit diesem Befehl aus. Er nennt dabei immer nur eine Version, die neuer ist als deine. pathrule update führt dieselbe Prüfung bei Bedarf aus, und pathrule config set update.policy manual schaltet die tägliche Prüfung ab.

Direkter Download

Es gibt weder einen eigenständigen Installer noch eine Paketmanager-Formel. Installiere Pathrule CLI auf jedem Betriebssystem über npm.

Prüfen

pathrule --version

Die CLI gibt ihre Version aus und beendet sich mit Exit-Code null. Wird der Befehl nicht gefunden, stelle sicher, dass das globale npm-Installationsverzeichnis in deinem PATH liegt, und öffne die Shell neu.

Anmelden

Für die Cloud-Nutzung brauchst du ein Konto. Das lokale Setup überspringt die Anmeldung; siehe Ohne Konto nutzen. pathrule login meldet dich standardmäßig mit einem Einmalcode an. Derselbe Befehl funktioniert auf deinem eigenen Rechner, über SSH und auf einem Rechner ohne Bildschirm oder einem CI-Runner.

Device-Code-Flow

pathrule login

Die CLI gibt einen Einmalcode aus. Auf einem Rechner mit Browser öffnet sie die Freigabeseite mit bereits eingetragenem Code: Melde dich dort bei deinem Pathrule-Konto an und gib die Anmeldung frei. Auf einem Rechner ohne Bildschirm oder über SSH öffnest du die ausgegebene URL auf einem beliebigen Gerät, gibst den Code ein und erteilst die Freigabe. Das Terminal schließt die Anmeldung selbstständig ab, und dein Passwort läuft nie darüber.

Mit --no-open verhinderst du, dass die CLI überhaupt einen Browser öffnet. Sie gibt dann stattdessen die URL aus. Ältere Anleitungen verwenden pathrule login --device-code; das wird weiterhin akzeptiert und startet denselben Ablauf.

Browser-PKCE-Flow

pathrule login --browser-callback

Damit meldest du dich in einem Browser auf demselben Rechner mit GitHub an. Die Session wird über einen Callback auf deinem eigenen Rechner an das Terminal zurückgegeben, abgesichert mit PKCE. Nutzt dein Konto Zwei-Faktor-Authentifizierung, fragt die CLI nach dem Code. Hierfür braucht sie ein interaktives Terminal und einen Browser. Wenn der Callback nicht nutzbar ist, meldet die CLI das und fährt mit dem Device-Code-Flow fort; mit --no-open oder in einem Skript verwendet sie den Device-Code-Flow von Anfang an.

pathrule whoami zeigt das Konto, mit dem du angemeldet bist. pathrule logout meldet die CLI ab, und pathrule logout --all meldet zusätzlich die anderen Pathrule-Oberflächen auf diesem Rechner ab, etwa die VS Code-Erweiterung.

Workspace anbinden

Ein Workspace ist die Einheit, der Pathrule Inhalte zuordnet. Die CLI bindet immer den Ordner an, in dem du sie ausführst, also wechsle zuerst in das Repository. Eine Option, die einen Pfad entgegennimmt, gibt es nicht.

Der geführte Weg erledigt alles in einem Durchlauf:

cd ~/repos/my-team
pathrule setup

pathrule setup beginnt mit der Wahl zwischen Pathrule Cloud und Local. Cloud ist der empfohlene verwaltete Einstieg, mit Konten, Organisationen und geteilter Intelligence. Local läuft auf diesem Rechner und braucht kein Konto. Das Setup verbindet den Workspace und die KI-Clients, die du auswählst. Auf einem Mac mit Apple Silicon bietet es außerdem das optionale On-Device-Modell an, das du überspringen kannst.

Das Cloud-Setup kann einen vorhandenen Workspace anbinden oder einen neuen für diesen Ordner anlegen. Die lokale Laufzeitumgebung liefert dann über die unterstützte Client-Konfiguration und die Hooks aus.

Schritt für Schritt geht es so:

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

pathrule workspace attach erwartet den exakten Namen des Workspace oder seine ID. Ohne Argument bindet es deinen aktuellen Workspace an. Willst du stattdessen einen neuen Workspace beginnen, legt pathrule init in einem Schritt einen nach dem Ordner benannten Workspace an und bindet ihn an; pathrule init my-team oder pathrule workspace create my-team tun dasselbe mit dem Namen, den du angibst. Workspaces stammen aus deiner aktuellen Organisation: pathrule org list zeigt deine Organisationen, und pathrule org use <slug> wechselt zwischen ihnen.

Nach dem Anbinden weiß die Laufzeitumgebung jedes Mal, wenn du in diesem Ordner oder darunter einen KI-Client startest, welche Workspace-Inhalte sie ausliefern soll.

In einem Skript nimmt pathrule setup seine Antworten als Optionen entgegen und braucht --yes, um tatsächlich etwas zu tun:

pathrule setup --workspace my-team --target all --yes

KI-Clients verbinden

pathrule setup fragt, welche KI-Clients du nutzt, installiert sie und merkt sich die Auswahl für diesen Workspace. So verbindest du einen Client von Hand:

pathrule install cursor
pathrule sync

pathrule install akzeptiert claude, cursor, codex, windsurf oder copilot; ohne Angabe eines Clients installiert es alle fünf. Es schreibt den MCP-Server-Eintrag von Pathrule in die eigene Konfiguration des jeweiligen Clients auf Benutzerebene und lässt alle anderen Server dort unangetastet. GitHub Copilot erhält zwei Einträge, einen für die Copilot CLI und einen für VS Code. pathrule uninstall <client> entfernt den Eintrag wieder.

pathrule sync schreibt die Dateien, die deine Clients lesen, in das Repository und aktualisiert den lokalen Hook-Index. Führe es in dem Ordner aus, an den der Workspace angebunden ist, und zwar nach dem Anbinden und immer dann, wenn diese Dateien wieder auf den Stand des Workspace gebracht werden sollen. Es schreibt für die KI-Clients, die in pathrule setup für diesen Workspace ausgewählt wurden. Ist keiner ausgewählt, schreibt es für die Clients, deren Pathrule-Dateien bereits im Repository liegen, und für Claude Code, wenn es keine gibt. pathrule sync --skills kopiert die Skills des Workspace in die Skill-Ordner deiner Clients.

Was Pathrule in dein Repository schreibt

Pathrule schreibt an die Stellen, die jeder Client ohnehin liest, sodass im Client nichts neu konfiguriert werden muss.

Pathrule kennzeichnet, was es schreibt: Seine Anweisungsdateien tragen ein Pathrule-Banner, und alles, was es einer deiner Dateien hinzufügt, steht in einem gekennzeichneten Block. Enthält eine Anweisungsdatei wie CLAUDE.md oder AGENTS.md bereits eigene Inhalte, sichert Pathrule deine Fassung vor dem Schreiben als Backup oder schreibt innerhalb seines gekennzeichneten Blocks und lässt den Rest der Datei unberührt. Ein Ordner .pathrule im Stammverzeichnis des Repositorys enthält die Aufzeichnung von Pathrule über die verwalteten Dateien sowie diese Backups. Mit pathrule sync --skills synchronisierte Skills landen im Skill-Ordner des jeweiligen Clients, etwa .claude/skills/, und wenn das Repository eine .gitignore hat, fügt Pathrule einen kommentierten Abschnitt hinzu, der diese Ordner aus git heraushält, bis du ihn löschst.

Außerhalb des Repositorys schreibt pathrule install die MCP-Einträge in die Konfiguration jedes Clients auf Benutzerebene, und die CLI legt ihre Session, ihren Cache und ihr Hook-Skript in deinem Pathrule-Home ab, standardmäßig ~/.pathrule.

Um zu sehen, was Pathrule in einem Ordner verwaltet, ohne etwas zu ändern, führe pathrule doctor aus. Es listet jede verwaltete Datei mit der Oberfläche und Version, die sie geschrieben hat. Die Client-Seiten gehen tiefer: Claude Code, Codex, Cursor, Windsurf und GitHub Copilot.

Ohne Konto nutzen

Pathrule CLI läuft auch vollständig auf deinem Rechner, ohne Konto und ohne Cloud. Im Projekt:

cd ~/repos/my-project
pathrule setup --local

pathrule init --local legt einen lokalen Workspace für den aktuellen Ordner an. pathrule setup --local tut dasselbe, installiert dann den lokalen MCP-Eintrag für jeden KI-Client, oder mit --target <client> für einen einzelnen, installiert die Hooks und schreibt die Repository-Dateien, alles ohne Anmeldung. Dein Agent schreibt Memories, Regeln und Skills über die MCP-Tools von Pathrule, und du liest und durchsuchst sie im Terminal mit --local, zum Beispiel pathrule memory list --local. Unter Ohne Konto arbeiten findest du alle lokalen Befehle, und unter Open-Source-Kern steht, was die lokale Edition umfasst.

Reines Open-Source-Setup

Pathrule CLI selbst ist Open Source unter Apache-2.0, und der lokale Modus betreibt es ohne Konto und ohne Cloud-Dienst. Das On-Device-Modell, das das Setup auf einem Mac mit Apple Silicon anbietet, ist optional: Lehne es ab, wenn das Setup danach fragt, oder entferne es später mit pathrule intelligence remove. Alles, was das Modell nicht braucht, funktioniert auch ohne es weiter. Open-Source-Kern listet, was heute Open Source ist und was proprietär.

Verkabelung prüfen

Doctor ist der eine Befehl, der das Setup durchgängig bestätigt. Er liest nur und ändert nie etwas.

pathrule doctor

Er prüft:

• Ob du angemeldet bist und eine Organisation und ein Workspace ausgewählt sind.
• Ob der aktuelle Ordner derjenige ist, an den der Workspace angebunden ist.
• Ob für jeden KI-Client der MCP-Eintrag von Pathrule installiert ist.
• Die Dateien, die Pathrule in diesem Ordner verwaltet, jeweils mit der Oberfläche und Version, die sie geschrieben hat. Eine Datei, die von einer anderen Oberfläche oder einer neueren Version geschrieben wurde, wird markiert.

Wenn etwas Aufmerksamkeit braucht, nennt doctor den nächsten Befehl, etwa pathrule login oder pathrule attach <workspace>. pathrule doctor --json liefert den vollständigen Bericht für ein Skript, der zusätzlich die Node.js-Version abdeckt und einen MCP-Eintrag mit veraltetem Startbefehl markiert; schlägt eine Prüfung fehl, endet der Befehl mit einem Exit-Code ungleich null. Einen veralteten Eintrag korrigiert pathrule repair: Es schreibt die Einträge von Pathrule in deinen Client-Konfigurationen neu, lässt alle anderen Server unangetastet und schreibt die Repository-Dateien erneut.

Pathrule aus einem Projekt entfernen

Beginne im Repository mit dem schreibgeschützten Plan:

pathrule eject

Er listet die Dateien und verwalteten Bereiche, die Pathrule gehören, einschließlich einer etwaigen Wiederherstellung deiner früheren Inhalte. Prüfe diesen Plan und wende ihn dann ausdrücklich an:

pathrule eject --apply

Bei einer Cloud-Ordneranbindung trennt pathrule detach den lokalen Ordner, ohne den Cloud-Workspace zu löschen. Auch die VS Code-Erweiterung kann die Bindung ihres Ordners aufheben.

Native Integrationen haben ihr eigenes aufgezeichnetes Setup. Mit pathrule integrations remove <agent> entfernst du eine davon. Einstellungsbasierte MCP-Einträge, die mit pathrule install installiert wurden, lassen sich mit pathrule uninstall <client> entfernen. Diese Vorgänge lassen fremde Client-Einstellungen und Server unverändert.

Weiterlesen

• Befehlsreferenz für alle Befehle und Optionen.
• Schnellstart, um deine erste Memory zu schreiben und zu sehen, wie der Hook auslöst.
• So funktionieren Hooks für das Modell, das erklärt, was doctor prüft.
• MCP-Überblick für die Tools, die der Assistent aufruft, sobald die Laufzeitumgebung läuft.