PathruleBefehlsreferenz
Alle Befehle von Pathrule CLI, was sie tun und welche Optionen wichtig sind, von Anmeldung und Workspace-Einrichtung bis zu Wissen, Diagnose und lokaler Nutzung ohne Konto.
Auf dieser Seite
- Globale Optionen
- Optionen, die ein Befehl nicht kennt
- JSON-Ausgabe
- Exit-Codes
- Loslegen
- Konto und Kontext
- Workspace-Einrichtung
- Wissen
- Deine Arbeitsvorlieben und das lokale Modell
- Local Console und Agent-Integrationen
- Projektintegration entfernen
- Diagnose und Wartung
- Team und Abrechnung
- Hilfe und Version
- Ohne Konto arbeiten
- Weiterlesen
Alle Befehle von Pathrule CLI, gruppiert wie in pathrule help. Zu jedem Eintrag steht, was der Befehl tut und welche Optionen wichtig sind. Für die erste Einrichtung beginnst du am besten mit Installation.
pathrule <command> [subcommand] [arguments] [options]
pathrule help
Globale Optionen
| Option | Was sie tut |
|---|---|
--json | Gibt statt der Ausgabe für Menschen ein einzelnes maschinenlesbares JSON-Objekt aus. Außerdem schaltet sie Farbe, Rückfragen und Browserfenster ab. |
--yes | Bestätigt die Rückfrage, die setup und cache prune stellen, bevor sie etwas ändern. |
--no-open | Öffnet nie einen Browser. Ein Befehl, der sonst einen öffnen würde, gibt stattdessen die URL aus. |
--no-color | Gibt schlichte Ausgabe ohne Farbe aus. Die Umgebungsvariable NO_COLOR auf 1 zu setzen bewirkt dasselbe. |
--local | Führt init, setup, sync, search und die Befehle memory, rule und skill gegen einen lokalen Speicher ohne Konto aus. Siehe Ohne Konto arbeiten. |
--help, -h | Gibt die Befehlsliste aus. |
--version, -v | Gibt die Version der CLI aus. |
Wenn die Umgebungsvariable CI den Wert true hat, überspringt die CLI ebenfalls Rückfragen und Browserfenster, sodass ein Befehl auf einem Runner nie auf eine Eingabe wartet.
Optionen, die ein Befehl nicht kennt
Die CLI weist eine Option, die sie nicht kennt, nicht zurück. Die meisten Befehle lesen sie als normales Argument, sodass der Befehl fehlschlägt oder auf das falsche Ziel wirkt. pathrule workspace attach --path ~/repos/app sucht nach einem Workspace namens --path, und pathrule install --client cursor bricht ab, weil --client kein Client-Name ist. setup, invite, team sowie memory add, rule add und skill add prüfen ihre eigenen Optionen und brechen bei einer unbekannten mit einem Fehler ab. Verwende die Optionen auf dieser Seite oder in pathrule help.
JSON-Ausgabe
Mit --json ist jede Antwort ein einzelnes JSON-Objekt mit ok, command und cwd, dazu data, wenn der Befehl erfolgreich war, oder error mit einem code und einer message, wenn nicht. Manche Antworten enthalten zusätzlich next_steps mit den Befehlen, die als Nächstes auszuführen sind. --json steht bei den Befehlen zur Verfügung, die es in --help anführen. snapshot und eject unterstützen es nicht, führe sie also ohne aus. Melde dich mit einfachem pathrule login an, denn der Anmeldeablauf muss dir einen Code anzeigen.
Exit-Codes
0 bedeutet, dass der Befehl getan hat, worum du ihn gebeten hast. Die meisten Bedienungsfehler, etwa ein fehlendes Argument oder ein unbekannter Client-Name, enden mit 64. Jeder andere Fehler endet mit 1, und pathrule doctor endet mit 1, wenn eine Prüfung fehlschlägt. Auf einer Node.js-Version älter als 20.11.1 bricht jeder Befehl mit 78 ab, bevor er irgendetwas tut.
Loslegen
| Befehl | Was er tut |
|---|---|
pathrule setup | Verbindet den aktuellen Ordner in einem geführten Durchlauf. Er meldet dich bei Bedarf an, schlägt die Workspaces deiner Organisation vor, die zu diesem Ordner passen (zum Beispiel mit demselben Git-Remote), verknüpft den gewählten oder legt einen nach dem Ordner benannten an, fragt, welche KI-Clients verbunden werden sollen, installiert sie, schreibt die Dateien, die sie lesen, und bietet an, in einem davon einen ersten Projektscan zu starten. Auf einem Mac mit Apple Silicon bietet er zum Schluss das optionale On-Device-Modell an. |
pathrule init [name] | Legt in deiner aktuellen Organisation einen Workspace an, benannt nach dem Ordner, sofern du keinen Namen angibst, und verknüpft den aktuellen Ordner damit. |
Ohne Terminal für Rückfragen gibt pathrule setup nur einen Plan aus: die Organisation, die passenden Workspaces und den Befehl, der den am besten passenden verknüpfen würde. Mit diesen Optionen handelt der Befehl tatsächlich, und dafür braucht er --yes:
--workspace <name-or-id>verknüpft einen bestehenden Workspace.--workspace-idist dieselbe Option.--create-workspacelegt einen nach dem Ordner benannten Workspace an. Mit--workspace-name <name>vergibst du den Namen selbst.--select-workspace <name-or-id>macht einen Workspace zum aktuellen, ohne diesen Ordner zu verknüpfen.--org <slug-or-id>wechselt zuerst die Organisation.--target <client>installiert den MCP-Eintrag fürclaude,cursor,codex,windsurf,copilotoderall.
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerun scannt die Dokumentation und Commit-Historie des Repositorys erneut und bereitet frische Kandidaten für Memories und Regeln für den ersten Projektscan des aktuellen Workspace vor.
Konto und Kontext
| Befehl | Was er tut |
|---|---|
pathrule login | Meldet dich mit einem einmaligen Code an. Die CLI gibt den Code aus und öffnet die Freigabeseite mit bereits eingetragenem Code im Browser, oder sie gibt die URL aus, die du auf einem beliebigen Gerät öffnen kannst, wenn kein Browser verfügbar ist. --no-open öffnet nie einen Browser. --browser-callback meldet dich in einem Browser auf diesem Rechner über GitHub an und kehrt über einen lokalen Callback zurück; geht das nicht, fällt es auf den Code zurück. --device-code wird akzeptiert und führt den Standardablauf mit Code aus. |
pathrule logout | Meldet Pathrule CLI auf diesem Rechner ab. --all meldet zusätzlich die anderen Pathrule-Oberflächen auf diesem Rechner ab, etwa die VS Code-Erweiterung. |
pathrule whoami | Zeigt das angemeldete Konto und wann die Session abläuft. |
pathrule org list | Listet deine Organisationen mit deiner Rolle auf und markiert die aktuelle mit *. Einfaches pathrule org tut dasselbe. |
pathrule org current | Zeigt die aktuelle Organisation und deine Rolle darin. |
pathrule org use <slug-or-id> | Wechselt die aktuelle Organisation. |
pathrule workspace list | Listet die Workspaces der aktuellen Organisation auf und markiert den aktuellen mit *. Einfaches pathrule workspace tut dasselbe. |
pathrule workspace current | Zeigt den aktuellen Workspace. |
pathrule workspace use <name-or-id> | Macht einen Workspace zum aktuellen, ohne einen Ordner zu verknüpfen. |
pathrule workspace create <name> | Legt einen Workspace an und verknüpft den aktuellen Ordner damit. |
pathrule workspace attach [name-or-id] | Verknüpft den aktuellen Ordner mit einem bestehenden Workspace, gefunden über seinen exakten Namen oder seine ID. Ohne Argument verknüpft er den aktuellen Workspace. Eine Pfadoption gibt es nicht: Führe ihn im Ordner aus. |
pathrule workspace detach [name-or-id] | Hebt die Ordnerverknüpfung des Workspace auf diesem Rechner auf. Der Workspace und sein Inhalt bleiben in Pathrule. |
pathrule workspace inspect | Zeigt den aktuellen Workspace im Detail: Organisation und Plan, wo er verknüpft ist, seinen Git-Remote, wie viele Memories, Regeln und Skills er enthält, die Plannutzung, welche KI-Clients eingerichtet sind und die letzten Aktivitäten. |
Verknüpfen, Anlegen, init und workspace use machen den betreffenden Workspace außerdem zum aktuellen. Befehle wie memory, rule, skill, search und sync arbeiten mit dem aktuellen Workspace.
Workspace-Einrichtung
| Befehl | Was er tut |
|---|---|
pathrule attach [name-or-id] | Dasselbe wie workspace attach. |
pathrule detach [name-or-id] | Dasselbe wie workspace detach. |
pathrule install [client] | Schreibt den MCP-Server-Eintrag von Pathrule in die Konfiguration eines KI-Clients auf Benutzerebene und lässt alle anderen Server darin unangetastet. Der Client ist claude (oder claude-code), cursor, codex, windsurf, copilot (oder github-copilot) oder all, das der Standard ist. GitHub Copilot erhält zwei Einträge, einen für die Copilot CLI und einen für VS Code. |
pathrule uninstall [client] | Entfernt den MCP-Eintrag von Pathrule aus der Konfiguration dieses Clients oder aus allen fünf. |
pathrule sync | Schreibt die Dateien, die deine KI-Clients lesen, ins Repository: Instruktionsdateien, Hook-Konfiguration und den lokalen Hook-Index. Führe ihn in dem Ordner aus, mit dem der Workspace verknüpft ist. --skills synchronisiert nur die Skills des Workspace in die Skill-Ordner deiner Clients. --local synchronisiert einen Workspace ohne Konto. |
pathrule mcp run | Startet den lokalen MCP-Server von Pathrule über Standardein- und -ausgabe. Diesen Befehl startet der von pathrule install geschriebene MCP-Eintrag, dein KI-Client führt ihn also aus, und du musst es nicht tun. |
pathrule sync schreibt Dateien für die KI-Clients, die in pathrule setup für diesen Workspace gewählt wurden. Ist keiner gewählt, schreibt er für die Clients, deren Pathrule-Dateien bereits im Repository liegen, und für Claude Code, wenn es keine gibt. CLAUDE.md und der Hook-Eintrag von Claude Code werden bei jedem Sync aktualisiert. Installation führt jede Datei auf. Wie du Pathrule wieder aus einem Repository entfernst, steht unter Pathrule aus einem Projekt entfernen.
Wissen
| Befehl | Was er tut |
|---|---|
pathrule search <query> | Durchsucht Memories, Regeln und Skills im aktuellen Workspace. --type memory,rule schränkt die Arten ein, --path /apps/api schränkt auf einen Pfad ein, und --limit <n> begrenzt die Ergebnisse. |
pathrule memory list | Listet Memories auf. --path oder ein vorangestellter Pfad schränkt die Liste ein, pathrule memory list /apps/api und pathrule /apps/api memory list sind also gleichwertig. --limit <n> begrenzt sie. |
pathrule memory read <id-or-title> | Gibt eine Memory aus. Mit --print wird langer Inhalt vollständig im Terminal ausgegeben. |
pathrule memory add | Schreibt eine Memory mit --path </node/path> --title <title>. Der Inhalt kommt aus --body, aus der Standardeingabe oder aus deinem Editor (VISUAL oder EDITOR), wenn du keines von beiden angibst. --allow-duplicate überspringt die Duplikatprüfung. |
pathrule rule list, read, add | Dasselbe für Regeln. rule add nimmt --name statt --title, dazu --priority (high, medium oder low, Standard medium) und --scope (project, folder oder file_type, Standard project). |
pathrule skill list, read, add | Dasselbe für Skills. skill add nimmt --name und optional --description. |
pathrule refresh list | Listet die offenen Refresh-Aufgaben auf, also die Anfragen, veraltetes Wissen zu aktualisieren. --include-in-progress nimmt die bereits übernommenen hinzu, und --limit <n> begrenzt die Liste. |
pathrule refresh claim [id] | Übernimmt eine Refresh-Aufgabe, ohne ID die nächste offene, und gibt ihre Kurzbeschreibung aus. |
pathrule refresh resolve <id> --status applied | Schließt eine Refresh-Aufgabe als applied oder rejected. --note "<text>" hält den Grund fest. |
pathrule snapshot | Erfasst eine Bestandsaufnahme des aktuellen Ordners mit Dateibaum, Manifesten und kurzen Auszügen aus der Dokumentation, Git-Branch und jüngster Historie, und lädt sie in den Workspace hoch. Andere Dateiinhalte liest er nicht. --dry-run gibt sie aus, ohne hochzuladen, und --notes "<text>" hängt eine Notiz an. |
pathrule snapshot list [n] | Listet die neuesten Snapshots des Workspace auf. |
Deine Arbeitsvorlieben und das lokale Modell
| Befehl | Was er tut |
|---|---|
pathrule me list | Listet auf, was User Intelligence darüber weiß, wie du arbeitest, sowohl was bereits genutzt wird als auch was noch nicht. Einfaches pathrule me tut dasselbe. |
pathrule me teach "<sentence>" | Bringt eine Vorliebe in deinen eigenen Worten bei. Dafür ist das optionale On-Device-Modell nötig. |
pathrule me explain <id> | Zeigt eine Vorliebe zusammen mit den Belegen dafür. Die ID ist die kurze ID, die me list ausgibt. |
pathrule me scope <id> | Beschränkt eine Vorliebe auf den Workspace, in dem du den Befehl ausführst. Mit --everywhere gilt sie in jedem Workspace. |
pathrule me forget <id> | Nutzt eine Vorliebe nicht mehr und behält sie als abgelehnt, damit dieselben Belege sie nicht zurückbringen. --delete entfernt sie vollständig. |
pathrule me context "<task>" | Gibt aus, was ein Agent für diese Aufgabe erhalten würde und welche Vorlieben zurückgehalten wurden und warum. |
pathrule intelligence status | Zeigt, ob das On-Device-Modell installiert ist, seine Version und ob ein Update verfügbar ist. Einfaches pathrule intelligence tut dasselbe. |
pathrule intelligence install | Richtet die lokale Laufzeitumgebung ein, die das Modell braucht, lädt dann das Modell herunter und prüft seine Prüfsumme, bevor es aktiv wird. Dafür ist ein Mac mit Apple Silicon nötig. |
pathrule intelligence update | Installiert ein neueres Modell, wenn eines verfügbar ist. Schlägt das Update fehl, bleibt dein bisheriges Modell erhalten. |
pathrule intelligence remove | Entfernt das Modell. Alles, was es nicht braucht, funktioniert weiter wie zuvor. |
Local Console und Agent-Integrationen
| Befehl | Was er tut |
|---|---|
pathrule ui | Öffnet die Local Console ohne Konto für Wissen, Aktivität und Local Signals. --port, --no-open und --json steuern, wie sie geöffnet wird. |
pathrule integrations | Interaktive Einrichtung für Claude Code und Codex. Außerhalb eines interaktiven Terminals listet er die Einrichtung auf. |
pathrule integrations add claude codex --local --dry-run | Zeigt eine Vorschau einer nativen Integration, ohne etwas zu schreiben. Wähle --cloud für den Cloud-Modus. |
pathrule integrations list | Listet erkannte Agents und erfasste Integrationen auf. |
pathrule integrations doctor | Prüft die installierte Integration, ohne etwas zu ändern. |
pathrule integrations repair | Wendet erfasste Pathrule-Integrationen erneut an. |
pathrule integrations remove <agent> | Entfernt die erfasste Integration. |
pathrule telemetry | Zeigt die Telemetrie-Einstellung und ob diese CLI senden kann. |
pathrule telemetry enable | Meldet eine angemeldete, verwaltete CLI für anonyme Nutzungsereignisse an. |
pathrule telemetry disable | Schaltet sie ab. |
Siehe Local Console und Native Agent-Integrationen.
Projektintegration entfernen
pathrule eject zeigt einen rein lesenden Plan, wie die Dateien und verwalteten Bereiche entfernt werden, die Pathrule im aktuellen Repository gehören. pathrule eject --apply führt ihn aus, nachdem du ihn geprüft hast. Eject hat keine --json-Variante. Native Plugins entfernst du über pathrule integrations remove <agent>.
Diagnose und Wartung
| Befehl | Was er tut |
|---|---|
pathrule status | Zeigt das angemeldete Konto, die aktuelle Organisation und den Plan, den aktuellen Workspace und ob dieser Ordner verknüpft ist. |
pathrule doctor | Führt rein lesende Prüfungen aus: Anmeldung, Organisation, Workspace, ob dieser Ordner verknüpft ist, ob jeder KI-Client den MCP-Eintrag von Pathrule hat, und die Dateien, die Pathrule in diesem Ordner verwaltet, jeweils mit der Oberfläche und Version, die sie geschrieben hat. Wenn etwas Aufmerksamkeit braucht, nennt er den nächsten Befehl. Mit --json deckt der Bericht auch die Node.js-Version ab und markiert einen MCP-Eintrag, dessen Startbefehl veraltet ist. --bundle schreibt eine Support-Datei, in der Zugangsdaten und lokale Pfade unkenntlich gemacht sind. |
pathrule repair | Schreibt veraltete MCP-Einträge von Pathrule in den Konfigurationen deiner KI-Clients neu, ohne andere Server anzutasten, schreibt die Repository-Dateien erneut und meldet, was sich geändert hat. |
pathrule preflight <action> | Prüft, ob dein Plan eine Aktion erlaubt, bevor du sie versuchst. Die Aktion ist create_workspace, write_memory, write_rule, write_skill, sync_agents oder materialize_skills. |
pathrule cache prune | Listet veraltete lokale Cache-Ordner auf, ohne sie zu entfernen. --yes entfernt sie. |
pathrule config get <key> | Liest eine Einstellung: update.policy, telemetry.enabled oder telemetry.id. |
pathrule config set <key> <value> | update.policy manual beendet die tägliche Update-Prüfung, während notify und auto sie beibehalten. telemetry.enabled false schaltet die anonyme Nutzungstelemetrie ab. Die Umgebungsvariable NO_TELEMETRY auf 1 zu setzen bewirkt dasselbe für einen Lauf oder eine Shell. |
pathrule config reset telemetry-id | Ersetzt die Telemetrie-ID durch eine neue. |
pathrule update | Prüft, ob es eine neuere CLI gibt, und gibt den Befehl aus, der sie installiert. Selbst installiert er nie etwas. |
Einmal am Tag prüft ein interaktiver Lauf außerdem, ob es eine neuere CLI gibt, und gibt einen einzeiligen Hinweis mit dem Upgrade-Befehl aus. Er nennt nur eine Version, die neuer als deine ist.
Die eigenständige lokale CLI sendet keine Telemetrie. Eine angemeldete, verwaltete CLI sendet anonyme Nutzungsereignisse erst, nachdem du mit pathrule telemetry enable zugestimmt hast. Die Ereignisse enthalten keinen Code, keine Pfade, Prompts, kein Wissen, keine E-Mail-Adresse und keine Konto- oder Workspace-IDs. Abschalten kannst du sie mit pathrule telemetry disable; NO_TELEMETRY=1, DO_NOT_TRACK=1 und CI halten sie ausgeschaltet.
Team und Abrechnung
| Befehl | Was er tut |
|---|---|
pathrule team | Listet die Mitglieder und offenen Einladungen der aktuellen Organisation auf, oder die von --org <slug-or-id>. pathrule team open öffnet Pathrule Web, wo Mitglieder verwaltet werden. |
pathrule invite <email> | Lädt eine Kollegin oder einen Kollegen als Editor in die aktuelle Organisation ein. --role setzt admin, editor oder viewer, und --org und --workspace legen Organisation und Workspace fest. Der Befehl meldet, ob die Einladungs-E-Mail verschickt wurde und wie sich die Einladung auf deine Plätze auswirkt. |
pathrule billing | Öffnet die Abrechnung der Organisation in Pathrule Web. |
pathrule upgrade | Öffnet die Abrechnung, um einen Plan zu wählen. |
Hilfe und Version
| Befehl | Was er tut |
|---|---|
pathrule help | Gibt die Befehlsliste aus. |
pathrule version | Gibt die Version der CLI aus, genau wie --version. |
Ohne Konto arbeiten
Pathrule CLI läuft auch auf einem lokalen Speicher, ohne Konto und ohne Cloud. Führe diese Befehle im Projekt aus:
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name] legt für den aktuellen Ordner einen lokalen Workspace an, der auf diesem Rechner bleibt, und verwendet den bestehenden weiter, falls schon einer den Ordner abdeckt. pathrule setup --local tut dasselbe und 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. --workspace-name <name> benennt einen neuen Workspace. Optionen, die ein Konto voraussetzen, etwa --org oder --workspace, brechen mit einem Fehler ab.
In einem lokalen Workspace schreibt dein KI-Agent Memories, Regeln und Skills über die MCP-Tools von Pathrule. Im Terminal liest und durchsuchst du sie mit --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 und skill add setzen ein Konto voraus. Mit --local weisen sie darauf hin und ändern nichts. Was die lokale Edition umfasst, steht unter Open-Source-Kern.
Weiterlesen
- Installation für die erste Einrichtung, was Pathrule in ein Repository schreibt und wie du es wieder entfernst.
- Pathrule CLI dafür, wofür die CLI zuständig ist und wann du sie verwendest.
- User Intelligence dafür, was
pathrule meverwaltet.