PathruleReferencia de comandos
Todos los comandos de Pathrule CLI, qué hace cada uno y las opciones que importan, desde el inicio de sesión y la configuración del espacio de trabajo hasta el conocimiento, el diagnóstico y el uso local sin cuenta.
En esta página
- Opciones globales
- Opciones que un comando no reconoce
- Salida JSON
- Códigos de salida
- Empezar
- Cuenta y contexto
- Configuración del espacio de trabajo
- Conocimiento
- Tus preferencias de trabajo y el modelo local
- Local Console e integraciones con agentes
- Quitar la integración del proyecto
- Diagnóstico y mantenimiento
- Equipo y facturación
- Ayuda y versión
- Trabajar sin cuenta
- Qué leer a continuación
Todos los comandos de Pathrule CLI, agrupados igual que los agrupa pathrule help. Cada entrada indica qué hace el comando y qué opciones importan. Para una primera configuración, empieza por Instalación.
pathrule <command> [subcommand] [arguments] [options]
pathrule help
Opciones globales
| Opción | Qué hace |
|---|---|
--json | Imprime un único objeto JSON legible por máquinas en lugar de la salida para personas. También desactiva el color, las preguntas interactivas y las ventanas del navegador. |
--yes | Acepta la confirmación que piden setup y cache prune antes de cambiar algo. |
--no-open | Nunca abre un navegador. Un comando que abriría uno imprime la URL en su lugar. |
--no-color | Imprime la salida sin color. Definir la variable de entorno NO_COLOR en 1 tiene el mismo efecto. |
--local | Ejecuta init, setup, sync, search y los comandos memory, rule y skill sobre un almacén local sin cuenta. Consulta Trabajar sin cuenta. |
--help, -h | Imprime la lista de comandos. |
--version, -v | Imprime la versión de la CLI. |
Cuando la variable de entorno CI vale true, la CLI también omite las preguntas interactivas y las ventanas del navegador, así que un comando nunca se queda esperando una entrada en un runner.
Opciones que un comando no reconoce
La CLI no rechaza una opción que no reconoce. La mayoría de los comandos la leen como un argumento común, lo que hace que el comando falle o actúe sobre el destino equivocado. pathrule workspace attach --path ~/repos/app busca un espacio de trabajo llamado --path, y pathrule install --client cursor se detiene porque --client no es el nombre de un cliente. setup, invite, team, y memory add, rule add y skill add validan sus propias opciones y se detienen con un error ante una que no reconocen. Usa las opciones de esta página o de pathrule help.
Salida JSON
Con --json, cada respuesta es un objeto JSON con ok, command y cwd, además de data cuando el comando tuvo éxito, o error con un code y un message cuando no. Algunas respuestas agregan next_steps con los comandos que conviene ejecutar a continuación. --json está disponible en los comandos que lo indican en --help. snapshot y eject no lo admiten, así que ejecútalos sin él. Inicia sesión con pathrule login sin opciones, ya que el flujo de inicio de sesión necesita mostrarte un código.
Códigos de salida
0 significa que el comando hizo lo que pediste. La mayoría de los errores de uso, como un argumento faltante o un nombre de cliente desconocido, terminan con 64. Cualquier otra falla termina con 1, y pathrule doctor termina con 1 cuando falla una verificación. En una versión de Node.js anterior a 20.11.1, todos los comandos se detienen con 78 antes de hacer cualquier cosa.
Empezar
| Comando | Qué hace |
|---|---|
pathrule setup | Conecta la carpeta actual en un único proceso guiado. Inicia tu sesión si hace falta, sugiere los espacios de trabajo de tu organización que coinciden con esta carpeta (el mismo remoto de git, por ejemplo), vincula el que elijas o crea uno con el nombre de la carpeta, pregunta qué clientes de IA conectar, los instala, escribe los archivos que leen y ofrece iniciar un primer escaneo del proyecto en uno de ellos. En una Mac con Apple Silicon, al final ofrece el modelo en el dispositivo opcional. |
pathrule init [name] | Crea un espacio de trabajo en tu organización actual, con el nombre de la carpeta a menos que indiques otro, y vincula la carpeta actual a él. |
Sin una terminal donde preguntar, pathrule setup solo imprime un plan: la organización, los espacios de trabajo que coinciden y el comando que vincularía el más adecuado. Estas opciones hacen que actúe, y para actuar necesita --yes:
--workspace <name-or-id>vincula un espacio de trabajo existente.--workspace-ides la misma opción.--create-workspacecrea un espacio de trabajo con el nombre de la carpeta. Agrega--workspace-name <name>para ponerle el nombre tú.--select-workspace <name-or-id>convierte un espacio de trabajo en el actual sin vincular esta carpeta.--org <slug-or-id>cambia primero de organización.--target <client>instala la entrada MCP paraclaude,cursor,codex,windsurf,copilotoall.
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerun vuelve a escanear la documentación y el historial de commits del repositorio y prepara nuevas candidatas de memorias y reglas para el primer escaneo del proyecto del espacio de trabajo actual.
Cuenta y contexto
| Comando | Qué hace |
|---|---|
pathrule login | Inicia sesión con un código de un solo uso. La CLI imprime el código y abre la página de aprobación en tu navegador con el código ya completado, o imprime la URL para abrirla en cualquier dispositivo cuando no hay navegador. --no-open nunca abre un navegador. --browser-callback inicia sesión con GitHub en un navegador de esta máquina y regresa mediante un callback local, y recurre al código cuando eso no es posible. --device-code se acepta y ejecuta el flujo de código predeterminado. |
pathrule logout | Cierra la sesión de Pathrule CLI en esta máquina. --all también cierra la sesión de las demás superficies de Pathrule en esta máquina, como la extensión de VS Code. |
pathrule whoami | Muestra la cuenta con sesión iniciada y cuándo vence la sesión. |
pathrule org list | Lista tus organizaciones con tu rol y marca la actual con *. pathrule org sin más hace lo mismo. |
pathrule org current | Muestra la organización actual y tu rol en ella. |
pathrule org use <slug-or-id> | Cambia la organización actual. |
pathrule workspace list | Lista los espacios de trabajo de la organización actual y marca el actual con *. pathrule workspace sin más hace lo mismo. |
pathrule workspace current | Muestra el espacio de trabajo actual. |
pathrule workspace use <name-or-id> | Convierte un espacio de trabajo en el actual sin vincular una carpeta. |
pathrule workspace create <name> | Crea un espacio de trabajo y vincula la carpeta actual a él. |
pathrule workspace attach [name-or-id] | Vincula la carpeta actual a un espacio de trabajo existente, identificado por su nombre exacto o su id. Sin argumento, vincula el espacio de trabajo actual. No hay opción de ruta: ejecútalo dentro de la carpeta. |
pathrule workspace detach [name-or-id] | Elimina el vínculo del espacio de trabajo con la carpeta en esta máquina. El espacio de trabajo y su contenido se mantienen en Pathrule. |
pathrule workspace inspect | Muestra el espacio de trabajo actual en detalle: su organización y plan, dónde está vinculado, su remoto de git, cuántas memorias, reglas y skills contiene, el uso del plan, qué clientes de IA están configurados y la actividad reciente. |
Vincular, crear, init y workspace use también convierten ese espacio de trabajo en el actual. Comandos como memory, rule, skill, search y sync trabajan sobre el espacio de trabajo actual.
Configuración del espacio de trabajo
| Comando | Qué hace |
|---|---|
pathrule attach [name-or-id] | Lo mismo que workspace attach. |
pathrule detach [name-or-id] | Lo mismo que workspace detach. |
pathrule install [client] | Escribe la entrada del servidor MCP de Pathrule en la configuración a nivel de usuario del propio cliente de IA y no toca ningún otro servidor que haya en ella. El cliente es claude (o claude-code), cursor, codex, windsurf, copilot (o github-copilot), o all, que es el valor predeterminado. GitHub Copilot recibe dos entradas, una para Copilot CLI y otra para VS Code. |
pathrule uninstall [client] | Elimina la entrada MCP de Pathrule de la configuración de ese cliente, o de los cinco. |
pathrule sync | Escribe en el repositorio los archivos que leen tus clientes de IA: archivos de instrucciones, configuración de hooks y el índice local de hooks. Ejecútalo en la carpeta a la que está vinculado el espacio de trabajo. --skills sincroniza solo las skills del espacio de trabajo en las carpetas de skills de tus clientes. --local sincroniza un espacio de trabajo sin cuenta. |
pathrule mcp run | Inicia el servidor MCP local de Pathrule por la entrada y salida estándar. Es el comando que lanza la entrada MCP escrita por pathrule install, así que lo ejecuta tu cliente de IA y no necesitas hacerlo tú. |
pathrule sync escribe archivos para los clientes de IA elegidos para este espacio de trabajo en pathrule setup. Cuando no hay ninguno elegido, escribe para los clientes cuyos archivos de Pathrule ya están en el repositorio, y para Claude Code cuando no hay ninguno. El CLAUDE.md y la entrada de hook de Claude Code se actualizan en cada sincronización. Instalación lista cada archivo. Para quitar Pathrule de un repositorio, consulta Quitar Pathrule de un proyecto.
Conocimiento
| Comando | Qué hace |
|---|---|
pathrule search <query> | Busca memorias, reglas y skills en el espacio de trabajo actual. --type memory,rule acota los tipos, --path /apps/api acota a una ruta y --limit <n> limita los resultados. |
pathrule memory list | Lista las memorias. --path o una ruta al inicio acotan la lista, así que pathrule memory list /apps/api y pathrule /apps/api memory list son equivalentes. --limit <n> la limita. |
pathrule memory read <id-or-title> | Imprime una memoria. Pasa --print para imprimir contenido largo completo en la terminal. |
pathrule memory add | Escribe una memoria con --path </node/path> --title <title>. El cuerpo viene de --body, de la entrada estándar o de tu editor (VISUAL o EDITOR) cuando no das ninguno de los dos. --allow-duplicate omite la verificación de duplicados. |
pathrule rule list, read, add | Lo mismo para las reglas. rule add recibe --name en lugar de --title, además de --priority (high, medium o low, predeterminado medium) y --scope (project, folder o file_type, predeterminado project). |
pathrule skill list, read, add | Lo mismo para las skills. skill add recibe --name y un --description opcional. |
pathrule refresh list | Lista las tareas de actualización abiertas, es decir, las solicitudes para actualizar conocimiento que quedó desactualizado. --include-in-progress agrega las que ya fueron tomadas y --limit <n> limita la lista. |
pathrule refresh claim [id] | Toma una tarea de actualización, la siguiente abierta cuando no das un id, e imprime su resumen. |
pathrule refresh resolve <id> --status applied | Cierra una tarea de actualización como applied o rejected. --note "<text>" registra el motivo. |
pathrule snapshot | Captura un inventario de la carpeta actual, con su árbol de archivos, manifiestos y breves muestras de la documentación, la rama de git y el historial reciente, y lo sube al espacio de trabajo. No lee el contenido de ningún otro archivo. --dry-run lo imprime sin subirlo y --notes "<text>" adjunta una nota. |
pathrule snapshot list [n] | Lista las instantáneas más recientes del espacio de trabajo. |
Tus preferencias de trabajo y el modelo local
| Comando | Qué hace |
|---|---|
pathrule me list | Lista lo que User Intelligence sabe sobre cómo trabajas, tanto lo que está en uso como lo que todavía no. pathrule me sin más hace lo mismo. |
pathrule me teach "<sentence>" | Enseña una preferencia con tus propias palabras. Necesita el modelo opcional en el dispositivo. |
pathrule me explain <id> | Muestra una preferencia con la evidencia que la respalda. El id es el id corto que imprime me list. |
pathrule me scope <id> | Limita una preferencia al espacio de trabajo donde lo ejecutas. --everywhere permite que se aplique en todos los espacios de trabajo. |
pathrule me forget <id> | Deja de usar una preferencia y la conserva como rechazada, para que la misma evidencia no la traiga de vuelta. --delete la elimina por completo. |
pathrule me context "<task>" | Imprime lo que recibiría un agente para esa tarea, y qué preferencias se retuvieron y por qué. |
pathrule intelligence status | Muestra si el modelo en el dispositivo está instalado, su versión y si hay una actualización disponible. pathrule intelligence sin más hace lo mismo. |
pathrule intelligence install | Configura el runtime local que necesita el modelo y luego descarga el modelo y verifica su checksum antes de activarlo. Necesita una Mac con Apple Silicon. |
pathrule intelligence update | Instala un modelo más reciente cuando hay uno disponible. Si la actualización falla, el modelo que tenías se mantiene. |
pathrule intelligence remove | Elimina el modelo. Todo lo que no lo necesita sigue funcionando como antes. |
Local Console e integraciones con agentes
| Comando | Qué hace |
|---|---|
pathrule ui | Abre la Local Console sin cuenta para conocimiento, actividad y Local Signals. --port, --no-open y --json controlan cómo se abre. |
pathrule integrations | Configuración interactiva para Claude Code y Codex. Fuera de una terminal interactiva, lista la configuración. |
pathrule integrations add claude codex --local --dry-run | Muestra una vista previa de una integración nativa sin escribir nada. Elige --cloud para el modo Cloud. |
pathrule integrations list | Lista los agentes detectados y las integraciones registradas. |
pathrule integrations doctor | Verificaciones de solo lectura de la integración instalada. |
pathrule integrations repair | Vuelve a aplicar las integraciones de Pathrule registradas. |
pathrule integrations remove <agent> | Elimina la integración registrada. |
pathrule telemetry | Muestra la preferencia de telemetría y si esta CLI puede enviar datos. |
pathrule telemetry enable | Activa los eventos de uso anónimos en una CLI administrada con sesión iniciada. |
pathrule telemetry disable | Los desactiva. |
Consulta Local Console e Integraciones nativas con agentes.
Quitar la integración del proyecto
pathrule eject muestra un plan de solo lectura para eliminar los archivos y las regiones administradas que pertenecen a Pathrule en el repositorio actual. pathrule eject --apply lo ejecuta después de que lo revisas. Eject no tiene una variante --json. Los plugins nativos se eliminan con pathrule integrations remove <agent>.
Diagnóstico y mantenimiento
| Comando | Qué hace |
|---|---|
pathrule status | Muestra la cuenta con sesión iniciada, la organización y el plan actuales, el espacio de trabajo actual y si esta carpeta está vinculada. |
pathrule doctor | Ejecuta verificaciones de solo lectura: inicio de sesión, organización, espacio de trabajo, si esta carpeta está vinculada, si cada cliente de IA tiene la entrada MCP de Pathrule, y los archivos que Pathrule administra en esta carpeta junto con la superficie y la versión que escribió cada uno. Indica el siguiente comando cuando algo requiere atención. Con --json, el informe también incluye la versión de Node.js y señala una entrada MCP cuyo comando de inicio está desactualizado. --bundle escribe un archivo de soporte con las credenciales y las rutas locales ocultas. |
pathrule repair | Reescribe las entradas MCP de Pathrule desactualizadas en las configuraciones de tus clientes de IA, sin tocar los demás servidores, vuelve a escribir los archivos del repositorio e informa qué cambió. |
pathrule preflight <action> | Verifica si tu plan permite una acción antes de intentarla. La acción es create_workspace, write_memory, write_rule, write_skill, sync_agents o materialize_skills. |
pathrule cache prune | Lista las carpetas de caché local obsoletas sin eliminarlas. --yes las elimina. |
pathrule config get <key> | Lee una preferencia: update.policy, telemetry.enabled o telemetry.id. |
pathrule config set <key> <value> | update.policy manual detiene la búsqueda diaria de actualizaciones, mientras que notify y auto la mantienen. telemetry.enabled false desactiva la telemetría de uso anónima. Definir la variable de entorno NO_TELEMETRY en 1 tiene el mismo efecto durante una ejecución o una sesión de shell. |
pathrule config reset telemetry-id | Reemplaza el id de telemetría por uno nuevo. |
pathrule update | Busca una CLI más reciente e imprime el comando que la instala. Nunca instala nada por su cuenta. |
Una vez al día, una ejecución interactiva también busca una CLI más reciente e imprime un aviso de una línea con el comando de actualización. Solo menciona una versión que sea más reciente que la tuya.
La CLI local independiente no envía telemetría. Una CLI administrada con sesión iniciada envía eventos de uso anónimos solo después de que das tu consentimiento con pathrule telemetry enable. Los eventos no incluyen código, rutas, prompts, conocimiento, correo electrónico ni ids de cuenta o de espacio de trabajo. Desactívalos con pathrule telemetry disable; NO_TELEMETRY=1, DO_NOT_TRACK=1 y CI los mantienen desactivados.
Equipo y facturación
| Comando | Qué hace |
|---|---|
pathrule team | Lista los miembros y las invitaciones pendientes de la organización actual, o de --org <slug-or-id>. pathrule team open abre Pathrule Web, donde se administran los miembros. |
pathrule invite <email> | Invita a un compañero de equipo a la organización actual como editor. --role define admin, editor o viewer, y --org y --workspace definen la organización y el espacio de trabajo. Informa si se envió el correo de invitación y cómo afecta la invitación a tus licencias. |
pathrule billing | Abre la facturación de la organización en Pathrule Web. |
pathrule upgrade | Abre la facturación para elegir un plan. |
Ayuda y versión
| Comando | Qué hace |
|---|---|
pathrule help | Imprime la lista de comandos. |
pathrule version | Imprime la versión de la CLI, igual que --version. |
Trabajar sin cuenta
Pathrule CLI funciona con un almacén local, sin cuenta y sin nube. Ejecuta esto dentro del proyecto:
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name] crea un espacio de trabajo local para la carpeta actual, guardado en esta máquina, y reutiliza el que ya cubre la carpeta si existe. pathrule setup --local hace lo mismo y luego instala la entrada MCP local para todos los clientes de IA, o para uno con --target <client>, instala los hooks y escribe los archivos del repositorio, todo sin iniciar sesión. --workspace-name <name> le da nombre a un espacio de trabajo nuevo. Las opciones que requieren una cuenta, como --org o --workspace, se detienen con un error.
En un espacio de trabajo local, tu agente de IA escribe memorias, reglas y skills mediante las herramientas MCP de Pathrule. Desde la terminal, las lees y buscas con --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 y skill add requieren una cuenta. Con --local lo indican y no cambian nada. Consulta Núcleo de código abierto para ver qué incluye la edición local.
Qué leer a continuación
- Instalación para la primera configuración, qué escribe Pathrule en un repositorio y cómo quitarlo.
- Pathrule CLI para saber de qué se encarga la CLI y cuándo usarla.
- User Intelligence para saber qué administra
pathrule me.