Aller au contenu
Pathrule

documentation

Pathrule CLI

L'interface terminal de Pathrule. Scriptable, adaptée à SSH, utilisable avec ou sans compte, et un runtime local complet pour les agents que vous pilotez depuis un shell.

Sur cette page

Pathrule CLI est l'interface d'installation et de terminal de Pathrule. Il est publié sur npm sous le nom @pathrule/cli avec la licence Apache-2.0, fonctionne sur macOS, Linux et Windows, et héberge dans votre shell le serveur MCP local, le cache local et le superviseur de hooks. Il connecte Claude Code, Codex, Cursor, Windsurf et GitHub Copilot, et convient aux usages via SSH, sans interface graphique ou en terminal autonome.

Le contenu et le contrat MCP sont communs à tous les clients, mais la livraison passe par le canal que chaque client expose. Claude Code et Codex reçoivent des hooks qui incluent un hook de prompt : le contexte arrive donc avant que l'agent n'agisse. Cursor et GitHub Copilot reçoivent des hooks de session et d'outils, sans hook de prompt. Windsurf n'a pas de hooks : il lit un fichier de règles généré et accède au contexte plus détaillé via MCP.

Ce dont Pathrule CLI se charge

  • Connexion. Un code d'appareil à usage unique par défaut, qui fonctionne de la même façon sur votre propre ordinateur, via SSH et sur toute machine sans interface graphique, ou une connexion GitHub par retour navigateur sur cette machine avec --browser-callback.
  • Rattachement d'espace de travail. Rattache le dossier depuis lequel vous le lancez à un espace de travail, pour que le runtime puisse résoudre le répertoire de travail de votre session IA. pathrule setup le fait de manière guidée, et pathrule init crée et rattache un espace de travail en une seule étape.
  • Installation et synchronisation des clients IA. Écrit l'entrée MCP de Pathrule dans Claude Code, Codex, Cursor, Windsurf et GitHub Copilot. pathrule sync écrit dans le dépôt les fichiers d'instructions et la configuration des hooks que lit chaque client.
  • Suppression. pathrule eject prévisualise le nettoyage du projet et pathrule eject --apply l'applique. Supprimez les intégrations natives avec pathrule integrations remove <agent> et les entrées MCP basées sur les paramètres avec pathrule uninstall <client>. Voir Supprimer Pathrule d'un projet.
  • Aucun compte requis. pathrule init --local et pathrule setup --local font fonctionner Pathrule sur un stockage local, sans connexion ni cloud. Voir Travailler sans compte.
  • Le modèle embarqué. pathrule intelligence installe, met à jour et supprime le modèle facultatif exécuté sur l'appareil, sur un Mac Apple Silicon. Rien d'autre n'en dépend. Voir le modèle local.
  • Serveur MCP. S'exécute en local et constitue l'interface avec laquelle dialogue votre assistant.
  • Superviseur de hooks. Enregistre les hooks pris en charge par chaque client compatible et fournit le contexte lié au chemin du dossier dans lequel l'agent travaille.
  • Vos préférences de travail. pathrule me liste, enseigne, explique, redéfinit la portée et oublie ce que User Intelligence sait de vous, conservé sur votre machine, et pathrule me context montre ce qu'un agent recevrait pour une tâche.
  • Les connaissances dans le terminal. pathrule search, list et read fonctionnent en Local comme en Cloud. La commande CLI add est réservée aux espaces de travail Cloud ; en local, la rédaction passe par la Local Console, VS Code ou MCP.
  • Doctor. Une seule commande, en lecture seule, qui vérifie votre connexion, l'espace de travail et le rattachement du dossier, l'entrée MCP de chaque client IA, ainsi que les fichiers que Pathrule gère dans le dossier. pathrule repair corrige les entrées obsolètes.
  • Scripts. Presque toutes les commandes acceptent --json pour une sortie stable et exploitable par une machine.

Toutes les commandes et options figurent dans la référence des commandes.

Parcours type

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

pathrule setup rattache le dossier à un espace de travail correspondant ou en crée un, vous demande quels clients IA connecter, les installe et écrit les fichiers qu'ils lisent. Pour créer l'espace de travail vous-même, lancez pathrule init my-project dans le dossier, ou pathrule workspace attach my-project pour un espace qui existe déjà. Les deux agissent sur le dossier courant, et aucune n'accepte d'option de chemin.

Ensuite, Claude Code ou Codex ouvert dans ~/repos/my-project reçoit le contexte Pathrule dès son premier prompt. Cursor et GitHub Copilot le reçoivent au démarrage de la session et autour des appels d'outils, et Windsurf le lit dans son fichier de règles et via MCP.

Modes de sortie

Le CLI dispose de deux modes de sortie, entre lesquels vous basculez avec --json.

  • Mode humain (par défaut) : des lignes d'état marquées ok, warn, error ou info, avec la prochaine commande à lancer quand c'est pertinent. Les invites et les fenêtres de navigateur n'apparaissent que dans un terminal interactif.
  • Mode JSON : un objet JSON par commande, pour les scripts, les runners de CI et l'automatisation. Il contient toujours ok, command et cwd, ainsi que data en cas de succès ou une error avec un code et un message. --json est disponible sur les commandes qui l'indiquent dans --help. snapshot et eject ne le prennent pas en charge, et ce mode n'affiche jamais d'invite et n'ouvre jamais de navigateur.
pathrule workspace list           # human
pathrule workspace list --json    # machine readable

Une commande se termine avec un code non nul lorsqu'elle n'a pas fait ce que vous avez demandé, ce qui fait échouer l'étape de CI correspondante.

Commandes qui ouvrent le navigateur

Quelques parcours sont propres au cloud et ouvrent Pathrule Web dans votre navigateur par défaut, plutôt que de réimplémenter la console dans le terminal.

pathrule billing
pathrule upgrade
pathrule team open

Chacune affiche l'URL qu'elle a ouverte. Avec --no-open, elle affiche l'URL sans rien ouvrir, pour que vous puissiez la copier depuis un shell distant. La commande pathrule team seule, sans sous-commande, liste les membres de l'organisation et les invitations en attente dans le terminal.

Quand utiliser Pathrule CLI

Utilisez Pathrule CLI lorsque vous travaillez via SSH, lorsque vous voulez intégrer Pathrule par script dans un runner de CI, lorsque vous voulez essayer Pathrule sans compte, ou tout simplement lorsque vous vivez dans le terminal. Pour parcourir et modifier les connaissances depuis votre éditeur, ajoutez Pathrule pour VS Code, qui partage la même connexion et les mêmes hooks.