PathruleRéférence des commandes
Toutes les commandes de Pathrule CLI, leur rôle et les options utiles, de la connexion et la configuration de l'espace de travail aux connaissances, au diagnostic et à l'usage local sans compte.
Sur cette page
- Options globales
- Options inconnues d'une commande
- Sortie JSON
- Codes de sortie
- Commencer
- Compte et contexte
- Configuration de l'espace de travail
- Connaissances
- Vos préférences de travail et le modèle local
- Local Console et intégrations d'agents
- Retirer l'intégration d'un projet
- Diagnostic et maintenance
- Équipe et facturation
- Aide et version
- Travailler sans compte
- Pour aller plus loin
Toutes les commandes de Pathrule CLI, regroupées comme le fait pathrule help. Chaque entrée indique ce que fait la commande et quelles options comptent. Pour une première configuration, commencez par Installation.
pathrule <command> [subcommand] [arguments] [options]
pathrule help
Options globales
| Option | Rôle |
|---|---|
--json | Affiche un unique objet JSON exploitable par une machine au lieu de la sortie lisible. Désactive aussi la couleur, les prompts et l'ouverture du navigateur. |
--yes | Accepte la confirmation que demandent setup et cache prune avant de modifier quoi que ce soit. |
--no-open | N'ouvre jamais de navigateur. Une commande qui en ouvrirait un affiche l'URL à la place. |
--no-color | Affiche une sortie brute, sans couleur. Définir la variable d'environnement NO_COLOR à 1 a le même effet. |
--local | Exécute init, setup, sync, search et les commandes memory, rule et skill sur un stockage local sans compte. Voir Travailler sans compte. |
--help, -h | Affiche la liste des commandes. |
--version, -v | Affiche la version du CLI. |
Lorsque la variable d'environnement CI vaut true, le CLI ignore aussi les prompts et l'ouverture du navigateur : une commande n'attend donc jamais de saisie sur un runner.
Options inconnues d'une commande
Le CLI ne rejette pas une option qu'il ne reconnaît pas. La plupart des commandes la lisent comme un simple argument, ce qui fait échouer la commande ou la fait agir sur la mauvaise cible. pathrule workspace attach --path ~/repos/app cherche un espace de travail nommé --path, et pathrule install --client cursor s'arrête parce que --client n'est pas un nom de client. setup, invite, team, ainsi que memory add, rule add et skill add vérifient leurs propres options et s'arrêtent sur une erreur en cas d'option inconnue. Utilisez les options décrites sur cette page ou dans pathrule help.
Sortie JSON
Avec --json, chaque réponse est un unique objet JSON contenant ok, command et cwd, plus data si la commande a réussi, ou error avec un code et un message dans le cas contraire. Certaines réponses ajoutent next_steps avec les commandes à lancer ensuite. --json est disponible sur les commandes qui l'indiquent dans --help. snapshot et eject ne la prennent pas en charge : lancez-les sans. Connectez-vous avec un simple pathrule login, car le processus de connexion doit vous afficher un code.
Codes de sortie
0 signifie que la commande a fait ce que vous demandiez. La plupart des erreurs d'utilisation, comme un argument manquant ou un nom de client inconnu, se terminent avec 64. Tout autre échec se termine avec 1, et pathrule doctor se termine avec 1 lorsqu'une vérification échoue. Sur une version de Node.js antérieure à 20.11.1, toute commande s'arrête avec 78 avant de faire quoi que ce soit.
Commencer
| Commande | Rôle |
|---|---|
pathrule setup | Connecte le dossier courant en une seule procédure guidée. Elle vous connecte si nécessaire, suggère les espaces de travail de votre organisation qui correspondent à ce dossier (le même remote git, par exemple), rattache celui que vous choisissez ou en crée un portant le nom du dossier, demande quels clients IA connecter, les installe, écrit les fichiers qu'ils lisent et propose de lancer une première analyse du projet dans l'un d'eux. Sur un Mac Apple Silicon, elle propose pour finir le modèle embarqué optionnel. |
pathrule init [name] | Crée un espace de travail dans votre organisation courante, portant le nom du dossier sauf si vous en indiquez un, et y rattache le dossier courant. |
Sans terminal où afficher des prompts, pathrule setup se contente d'afficher un plan : l'organisation, les espaces de travail correspondants et la commande qui rattacherait le meilleur. Les options suivantes le font agir, et agir nécessite --yes :
--workspace <name-or-id>rattache un espace de travail existant.--workspace-idest la même option.--create-workspacecrée un espace de travail portant le nom du dossier. Ajoutez--workspace-name <name>pour le nommer vous-même.--select-workspace <name-or-id>rend un espace de travail courant sans y rattacher ce dossier.--org <slug-or-id>change d'abord d'organisation.--target <client>installe l'entrée MCP pourclaude,cursor,codex,windsurf,copilotouall.
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerun analyse à nouveau la documentation et l'historique des commits du dépôt, et prépare de nouveaux candidats de mémoires et de règles pour la première analyse du projet de l'espace de travail courant.
Compte et contexte
| Commande | Rôle |
|---|---|
pathrule login | Vous connecte avec un code à usage unique. Le CLI affiche le code et ouvre la page d'approbation dans votre navigateur avec le code prérempli, ou affiche l'URL à ouvrir sur n'importe quel appareil s'il n'y a pas de navigateur. --no-open n'ouvre jamais de navigateur. --browser-callback vous connecte avec GitHub dans un navigateur sur cette machine et revient via un callback local, avec repli sur le code lorsque ce n'est pas possible. --device-code est accepté et lance le processus par code par défaut. |
pathrule logout | Déconnecte Pathrule CLI sur cette machine. --all déconnecte aussi les autres surfaces Pathrule de cette machine, comme l'extension VS Code. |
pathrule whoami | Affiche le compte connecté et la date d'expiration de la session. |
pathrule org list | Liste vos organisations avec votre rôle et signale l'organisation courante par *. Un simple pathrule org fait la même chose. |
pathrule org current | Affiche l'organisation courante et votre rôle dans celle-ci. |
pathrule org use <slug-or-id> | Change l'organisation courante. |
pathrule workspace list | Liste les espaces de travail de l'organisation courante et signale l'espace courant par *. Un simple pathrule workspace fait la même chose. |
pathrule workspace current | Affiche l'espace de travail courant. |
pathrule workspace use <name-or-id> | Rend un espace de travail courant sans y rattacher de dossier. |
pathrule workspace create <name> | Crée un espace de travail et y rattache le dossier courant. |
pathrule workspace attach [name-or-id] | Rattache le dossier courant à un espace de travail existant, identifié par son nom exact ou son id. Sans argument, rattache l'espace de travail courant. Il n'existe aucune option de chemin : lancez la commande dans le dossier. |
pathrule workspace detach [name-or-id] | Supprime le rattachement du dossier à l'espace de travail sur cette machine. L'espace de travail et son contenu restent dans Pathrule. |
pathrule workspace inspect | Affiche le détail de l'espace de travail courant : son organisation et son offre, l'endroit où il est rattaché, son remote git, le nombre de mémoires, règles et skills qu'il contient, l'utilisation de l'offre, les clients IA configurés et l'activité récente. |
Rattacher, créer, init et workspace use rendent aussi cet espace de travail courant. Des commandes comme memory, rule, skill, search et sync agissent sur l'espace de travail courant.
Configuration de l'espace de travail
| Commande | Rôle |
|---|---|
pathrule attach [name-or-id] | Identique à workspace attach. |
pathrule detach [name-or-id] | Identique à workspace detach. |
pathrule install [client] | Écrit l'entrée du serveur MCP de Pathrule dans la configuration utilisateur propre à un client IA, sans toucher aux autres serveurs qu'elle contient. Le client est claude (ou claude-code), cursor, codex, windsurf, copilot (ou github-copilot), ou all, la valeur par défaut. GitHub Copilot reçoit deux entrées, l'une pour le Copilot CLI et l'autre pour VS Code. |
pathrule uninstall [client] | Supprime l'entrée MCP de Pathrule de la configuration de ce client, ou des cinq. |
pathrule sync | Écrit dans le dépôt les fichiers que lisent vos clients IA : fichiers d'instructions, configuration des hooks et index local des hooks. Lancez-la dans le dossier rattaché à l'espace de travail. --skills ne synchronise que les skills de l'espace de travail dans les dossiers de skills de vos clients. --local synchronise un espace de travail sans compte. |
pathrule mcp run | Démarre le serveur MCP local de Pathrule sur l'entrée et la sortie standard. C'est la commande que lance l'entrée MCP écrite par pathrule install : votre client IA l'exécute, vous n'avez pas à le faire. |
pathrule sync écrit les fichiers des clients IA choisis pour cet espace de travail dans pathrule setup. Si aucun n'a été choisi, elle écrit pour les clients dont les fichiers Pathrule figurent déjà dans le dépôt, et pour Claude Code s'il n'y en a aucun. Le CLAUDE.md et l'entrée de hook de Claude Code sont actualisés à chaque synchronisation. Installation détaille chaque fichier. Pour retirer Pathrule d'un dépôt, voir Retirer Pathrule d'un projet.
Connaissances
| Commande | Rôle |
|---|---|
pathrule search <query> | Recherche dans les mémoires, règles et skills de l'espace de travail courant. --type memory,rule restreint les types, --path /apps/api restreint à un chemin et --limit <n> plafonne le nombre de résultats. |
pathrule memory list | Liste les mémoires. --path ou un chemin placé en tête restreint la liste : pathrule memory list /apps/api et pathrule /apps/api memory list sont donc équivalents. --limit <n> la plafonne. |
pathrule memory read <id-or-title> | Affiche une mémoire. Ajoutez --print pour afficher en entier un contenu long dans le terminal. |
pathrule memory add | Écrit une mémoire avec --path </node/path> --title <title>. Le corps provient de --body, de l'entrée standard, ou de votre éditeur (VISUAL ou EDITOR) si vous ne fournissez ni l'un ni l'autre. --allow-duplicate ignore la vérification des doublons. |
pathrule rule list, read, add | Pareil pour les règles. rule add prend --name au lieu de --title, ainsi que --priority (high, medium ou low, medium par défaut) et --scope (project, folder ou file_type, project par défaut). |
pathrule skill list, read, add | Pareil pour les skills. skill add prend --name et un --description optionnel. |
pathrule refresh list | Liste les tâches d'actualisation ouvertes, c'est-à-dire les demandes de mise à jour de connaissances devenues obsolètes. --include-in-progress ajoute celles déjà prises en charge, et --limit <n> plafonne la liste. |
pathrule refresh claim [id] | Prend en charge une tâche d'actualisation, la prochaine ouverte si vous n'indiquez pas d'id, et affiche son brief. |
pathrule refresh resolve <id> --status applied | Clôt une tâche d'actualisation avec le statut applied ou rejected. --note "<text>" en consigne la raison. |
pathrule snapshot | Capture un inventaire du dossier courant (arborescence des fichiers, manifestes et courts extraits de documentation, branche git et historique récent) et l'envoie à l'espace de travail. Elle ne lit le contenu d'aucun autre fichier. --dry-run l'affiche sans l'envoyer, et --notes "<text>" y joint une note. |
pathrule snapshot list [n] | Liste les snapshots les plus récents de l'espace de travail. |
Vos préférences de travail et le modèle local
| Commande | Rôle |
|---|---|
pathrule me list | Liste ce que User Intelligence sait de votre façon de travailler, aussi bien ce qui est utilisé que ce qui ne l'est pas encore. Un simple pathrule me fait la même chose. |
pathrule me teach "<sentence>" | Enseigne une préférence avec vos propres mots. Nécessite le modèle embarqué optionnel. |
pathrule me explain <id> | Affiche une préférence avec les éléments qui la justifient. L'id est l'id court affiché par me list. |
pathrule me scope <id> | Limite une préférence à l'espace de travail dans lequel vous lancez la commande. --everywhere l'applique dans tous les espaces de travail. |
pathrule me forget <id> | Cesse d'utiliser une préférence et la conserve comme rejetée, pour que les mêmes éléments ne la fassent pas revenir. --delete la supprime entièrement. |
pathrule me context "<task>" | Affiche ce qu'un agent recevrait pour cette tâche, ainsi que les préférences écartées et pourquoi. |
pathrule intelligence status | Indique si le modèle embarqué est installé, sa version et si une mise à jour est disponible. Un simple pathrule intelligence fait la même chose. |
pathrule intelligence install | Configure l'environnement d'exécution local dont le modèle a besoin, puis télécharge le modèle et vérifie sa somme de contrôle avant de l'activer. Nécessite un Mac Apple Silicon. |
pathrule intelligence update | Installe un modèle plus récent lorsqu'il y en a un. Si la mise à jour échoue, le modèle existant reste en place. |
pathrule intelligence remove | Supprime le modèle. Tout ce qui n'en dépend pas continue de fonctionner comme avant. |
Local Console et intégrations d'agents
| Commande | Rôle |
|---|---|
pathrule ui | Ouvre la Local Console sans compte, pour les connaissances, l'activité et les Local Signals. --port, --no-open et --json contrôlent son ouverture. |
pathrule integrations | Configuration interactive pour Claude Code et Codex. Hors d'un terminal interactif, liste la configuration. |
pathrule integrations add claude codex --local --dry-run | Prévisualise une intégration native sans rien écrire. Choisissez --cloud pour le mode Cloud. |
pathrule integrations list | Liste les agents détectés et les intégrations enregistrées. |
pathrule integrations doctor | Vérifications en lecture seule de l'intégration installée. |
pathrule integrations repair | Réapplique les intégrations Pathrule enregistrées. |
pathrule integrations remove <agent> | Supprime l'intégration enregistrée. |
pathrule telemetry | Affiche la préférence de télémétrie et indique si ce CLI peut envoyer des données. |
pathrule telemetry enable | Active, pour un CLI géré connecté, l'envoi d'événements d'usage anonymes. |
pathrule telemetry disable | Les désactive. |
Voir Local Console et Intégrations natives des agents.
Retirer l'intégration d'un projet
pathrule eject affiche un plan en lecture seule pour supprimer les fichiers et les zones gérées dont Pathrule est propriétaire dans le dépôt courant. pathrule eject --apply l'exécute une fois que vous l'avez relu. Eject n'a pas de variante --json. Les plugins natifs se suppriment avec pathrule integrations remove <agent>.
Diagnostic et maintenance
| Commande | Rôle |
|---|---|
pathrule status | Affiche le compte connecté, l'organisation et l'offre courantes, l'espace de travail courant et indique si ce dossier est rattaché. |
pathrule doctor | Lance des vérifications en lecture seule : connexion, organisation, espace de travail, rattachement de ce dossier, présence de l'entrée MCP de Pathrule dans chaque client IA, et fichiers gérés par Pathrule dans ce dossier avec la surface et la version qui ont écrit chacun d'eux. Elle indique la commande suivante lorsque quelque chose demande votre attention. Avec --json, le rapport couvre aussi la version de Node.js et signale une entrée MCP dont la commande de lancement est obsolète. --bundle écrit un fichier pour le support, avec les identifiants et les chemins locaux masqués. |
pathrule repair | Réécrit les entrées MCP de Pathrule obsolètes dans les configurations de vos clients IA, sans toucher aux autres serveurs, écrit à nouveau les fichiers du dépôt et indique ce qui a changé. |
pathrule preflight <action> | Vérifie si votre offre autorise une action avant de la tenter. L'action est create_workspace, write_memory, write_rule, write_skill, sync_agents ou materialize_skills. |
pathrule cache prune | Liste les dossiers de cache locaux obsolètes sans les supprimer. --yes les supprime. |
pathrule config get <key> | Lit une préférence : update.policy, telemetry.enabled ou telemetry.id. |
pathrule config set <key> <value> | update.policy manual arrête la vérification quotidienne des mises à jour, tandis que notify et auto la conservent. telemetry.enabled false désactive la télémétrie d'usage anonyme. Définir la variable d'environnement NO_TELEMETRY à 1 a le même effet pour une exécution ou un shell. |
pathrule config reset telemetry-id | Remplace l'id de télémétrie par un nouveau. |
pathrule update | Vérifie s'il existe un CLI plus récent et affiche la commande qui l'installe. Elle n'installe jamais rien elle-même. |
Une fois par jour, une exécution interactive vérifie aussi s'il existe un CLI plus récent et affiche un avis d'une ligne avec la commande de mise à niveau. Elle ne mentionne qu'une version plus récente que la vôtre.
Le CLI local autonome n'envoie aucune télémétrie. Un CLI géré connecté n'envoie d'événements d'usage anonymes qu'après votre accord explicite via pathrule telemetry enable. Ces événements ne contiennent ni code, ni chemins, ni prompts, ni connaissances, ni e-mail, ni id de compte ou d'espace de travail. Désactivez-les avec pathrule telemetry disable ; NO_TELEMETRY=1, DO_NOT_TRACK=1 et la CI les maintiennent désactivés.
Équipe et facturation
| Commande | Rôle |
|---|---|
pathrule team | Liste les membres et les invitations en attente de l'organisation courante, ou de --org <slug-or-id>. pathrule team open ouvre Pathrule Web, où se gèrent les membres. |
pathrule invite <email> | Invite un collègue dans l'organisation courante en tant qu'éditeur. --role définit admin, editor ou viewer, et --org et --workspace définissent l'organisation et l'espace de travail. Elle indique si l'e-mail d'invitation est parti et l'effet de l'invitation sur vos sièges. |
pathrule billing | Ouvre la facturation de l'organisation dans Pathrule Web. |
pathrule upgrade | Ouvre la facturation pour choisir une offre. |
Aide et version
| Commande | Rôle |
|---|---|
pathrule help | Affiche la liste des commandes. |
pathrule version | Affiche la version du CLI, comme --version. |
Travailler sans compte
Pathrule CLI fonctionne sur un stockage local, sans compte et sans cloud. Lancez ces commandes dans le projet :
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name] crée pour le dossier courant un espace de travail local, conservé sur cette machine, et réutilise celui qui couvre déjà le dossier s'il en existe un. pathrule setup --local fait de même, puis installe l'entrée MCP locale pour chaque client IA, ou pour un seul avec --target <client>, installe les hooks et écrit les fichiers du dépôt, le tout sans connexion. --workspace-name <name> nomme un nouvel espace de travail. Les options qui nécessitent un compte, comme --org ou --workspace, s'arrêtent sur une erreur.
Dans un espace de travail local, votre agent IA écrit les mémoires, règles et skills via les outils MCP de Pathrule. Depuis le terminal, vous les lisez et les recherchez avec --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 et skill add nécessitent un compte. Avec --local, elles le signalent et ne modifient rien. Voir Cœur open source pour le contenu de l'édition locale.
Pour aller plus loin
- Installation pour la première configuration, ce que Pathrule écrit dans un dépôt et comment le retirer.
- Pathrule CLI pour le périmètre du CLI et les cas où l'utiliser.
- User Intelligence pour ce que gère
pathrule me.