Saltar al contenido
Pathrule

documentación

Pathrule CLI

La superficie de Pathrule pensada para la terminal. Admite scripts, funciona por SSH, se usa con o sin cuenta y ofrece un runtime local completo para los agentes que manejas desde una shell.

En esta página

Pathrule CLI es la superficie de instalación y de terminal de Pathrule. Se publica en npm como @pathrule/cli bajo la licencia Apache-2.0, funciona en macOS, Linux y Windows, y aloja en tu shell el servidor MCP local, la caché local y el supervisor de hooks. Conecta Claude Code, Codex, Cursor, Windsurf y GitHub Copilot, y se adapta a flujos de trabajo por SSH, sin interfaz gráfica y en terminales independientes.

El contenido y el contrato MCP son los mismos para todos los clientes, pero la entrega sigue el canal que expone cada uno. Claude Code y Codex reciben hooks que incluyen un hook de prompt, así que el contexto llega antes de que el agente actúe. Cursor y GitHub Copilot reciben hooks de sesión y de herramientas, sin hook de prompt. Windsurf no tiene hooks: lee un archivo de reglas generado y accede a un contexto más profundo a través de MCP.

De qué se encarga Pathrule CLI

  • Inicio de sesión. Un código de dispositivo de un solo uso de forma predeterminada, que funciona igual en tu propia computadora, por SSH y en cualquier máquina sin interfaz gráfica, o inicio de sesión con GitHub mediante un callback del navegador en esta máquina con --browser-callback.
  • Vinculación del espacio de trabajo. Vincula la carpeta en la que la ejecutas a un espacio de trabajo, para que el runtime pueda resolver el directorio de trabajo de tu sesión de IA. pathrule setup lo hace de forma guiada y pathrule init crea y vincula un espacio de trabajo en un solo paso.
  • Instalación y sincronización de clientes de IA. Escribe la entrada MCP de Pathrule en Claude Code, Codex, Cursor, Windsurf y GitHub Copilot. pathrule sync escribe en el repositorio los archivos de instrucciones y la configuración de hooks que lee cada cliente.
  • Desinstalación. pathrule eject muestra una vista previa de la limpieza del proyecto y pathrule eject --apply la aplica. Quita las integraciones nativas con pathrule integrations remove <agent> y las entradas MCP basadas en configuración con pathrule uninstall <client>. Consulta Quitar Pathrule de un proyecto.
  • Sin necesidad de cuenta. pathrule init --local y pathrule setup --local ejecutan Pathrule sobre un almacenamiento local, sin iniciar sesión y sin nube. Consulta Trabajar sin cuenta.
  • El modelo en el dispositivo. pathrule intelligence instala, actualiza y elimina el modelo opcional en el dispositivo en una Mac con Apple Silicon. Nada más depende de él. Consulta el modelo local.
  • Servidor MCP. Se ejecuta en local y es la superficie con la que se comunica tu asistente.
  • Supervisor de hooks. Registra los hooks que admite cada cliente compatible con hooks y entrega el contexto vinculado a la ruta de la carpeta en la que trabaja el agente.
  • Tus preferencias de trabajo. pathrule me lista, enseña, explica, cambia el alcance y olvida lo que User Intelligence guarda sobre ti, almacenado en tu máquina, y pathrule me context muestra lo que recibiría un agente para una tarea.
  • Conocimiento en la terminal. pathrule search, list y read funcionan en Local y en Cloud. add de la CLI es para espacios de trabajo de Cloud; para crear contenido en local se usa la Local Console, VS Code o MCP.
  • Doctor. Un único comando de solo lectura que revisa tu sesión, el espacio de trabajo y la vinculación de la carpeta, la entrada MCP de cada cliente de IA y los archivos que Pathrule administra en la carpeta. pathrule repair corrige las entradas desactualizadas.
  • Scripts. Casi todos los comandos aceptan --json para obtener una salida estable y legible por máquinas.

Todos los comandos y opciones están en la referencia de comandos.

Flujo habitual

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

pathrule setup vincula la carpeta a un espacio de trabajo que coincida o crea uno, te pregunta qué clientes de IA quieres conectar, los instala y escribe los archivos que leen. Para crear el espacio de trabajo tú mismo, ejecuta pathrule init my-project en la carpeta, o pathrule workspace attach my-project si ya existe. Ambos actúan sobre la carpeta actual y ninguno acepta una opción de ruta.

A partir de ahí, Claude Code o Codex abiertos en ~/repos/my-project reciben el contexto de Pathrule para su primer prompt. Cursor y GitHub Copilot lo reciben al iniciar la sesión y alrededor de las llamadas a herramientas, y Windsurf lo lee de su archivo de reglas y a través de MCP.

Modos de salida

La CLI tiene dos modos de salida, entre los que cambias con --json.

  • Modo para personas (predeterminado): Líneas de estado marcadas como ok, warn, error o info, con el siguiente comando que debes ejecutar cuando corresponde. Las preguntas interactivas y las ventanas del navegador solo aparecen en una terminal interactiva.
  • Modo JSON: Un objeto JSON por comando, para scripts, runners de CI y automatización. Siempre incluye ok, command y cwd, además de data si tiene éxito o un error con un code y un message. --json está disponible en los comandos que lo indican en --help. snapshot y eject no lo admiten, y nunca hace preguntas ni abre el navegador.
pathrule workspace list           # human
pathrule workspace list --json    # machine readable

Un comando termina con un código distinto de cero cuando no hizo lo que le pediste, así que un paso de CI falla en ese caso.

Comandos que abren el navegador

Algunos flujos son exclusivos de la nube y abren Pathrule Web en tu navegador predeterminado en lugar de reimplementar la consola en la terminal.

pathrule billing
pathrule upgrade
pathrule team open

Cada uno imprime la URL que abrió. Con --no-open imprime la URL sin abrir nada, para que puedas copiarla desde una shell remota. pathrule team a secas lista en la terminal los miembros de la organización y las invitaciones pendientes.

Cuándo usar Pathrule CLI

Usa Pathrule CLI cuando trabajes por SSH, cuando quieras integrar Pathrule en un runner de CI mediante scripts, cuando quieras probar Pathrule sin cuenta o, simplemente, cuando vivas en la terminal. Para explorar y editar conocimiento dentro de tu editor, agrega Pathrule para VS Code, que comparte el mismo inicio de sesión y los mismos hooks.