Instalación

Pathrule CLI es la interfaz de Pathrule pensada para la terminal. Se publica en npm como @pathrule/cli bajo la licencia Apache-2.0 y ejecuta el servidor MCP local, el supervisor de hooks y la caché local para los agentes que manejas desde una shell. En esta página verás cómo instalarla, iniciar sesión, conectar un repositorio y tus clientes de IA, usarla sin cuenta y volver a quitarla de un proyecto. Todos los comandos están en la referencia de comandos.

Requisitos

• macOS, Linux o Windows.
• Node.js 20.11.1 o posterior. La CLI comprueba la versión en cada ejecución y, si es anterior, se detiene con un mensaje claro.
• Una shell moderna: zsh, bash o fish, o PowerShell en Windows.
• Un asistente de programación con IA compatible con MCP. Pathrule CLI conecta Claude Code, Codex, Cursor, Windsurf y GitHub Copilot. No es obligatorio para instalar, pero te conviene tener uno para verificar el flujo de hooks.

Instalar

npm (macOS, Linux, Windows)

npm es la vía de instalación en los tres sistemas operativos. Requiere Node.js 20.11.1 o posterior.

npm install -g @pathrule/cli

En Windows, ejecútalo desde PowerShell. Pathrule registra automáticamente un comando de hook compatible con Windows, así que los mismos comandos pathrule funcionan ahí exactamente igual que en una shell de Unix.

Para actualizar, ejecuta la misma instalación con @latest:

npm install -g @pathrule/cli@latest

Una vez al día, una ejecución interactiva busca una versión más reciente y muestra un aviso de una línea con este comando. Solo menciona versiones más nuevas que la tuya. pathrule update hace la misma comprobación cuando la pidas, y pathrule config set update.policy manual desactiva la comprobación diaria.

Descarga directa

No hay instalador independiente ni fórmula para gestores de paquetes. Instala Pathrule CLI con npm en cualquier sistema operativo.

Verificar

pathrule --version

La CLI muestra su versión y termina con código cero. Si no se encuentra el comando, asegúrate de que la ubicación de instalación global de npm esté en tu PATH y vuelve a abrir la shell.

Iniciar sesión

Para usar Cloud necesitas una cuenta. La configuración local omite el inicio de sesión; consulta Úsalo sin cuenta. pathrule login inicia sesión con un código de un solo uso de forma predeterminada. El mismo comando funciona en tu propia computadora, por SSH y en un equipo sin interfaz gráfica o un runner de CI.

Flujo con código de dispositivo

pathrule login

La CLI muestra un código de un solo uso. En una máquina con navegador, abre la página de aprobación con el código ya completado: inicia sesión ahí en tu cuenta de Pathrule y aprueba. En un equipo sin interfaz gráfica o por SSH, abre la URL que aparece en cualquier dispositivo, escribe el código y aprueba. La terminal termina de iniciar sesión por sí sola, y tu contraseña nunca pasa por ella.

Usa --no-open para que la CLI no abra ningún navegador. En su lugar, muestra la URL. Las guías anteriores usan pathrule login --device-code, que se sigue aceptando y ejecuta este mismo flujo.

Flujo PKCE en el navegador

pathrule login --browser-callback

Esto inicia sesión con GitHub en un navegador de la misma máquina y devuelve la sesión a la terminal mediante un callback en tu propia máquina, protegido con PKCE. Si tu cuenta usa autenticación de dos factores, la CLI te pide el código. En este caso necesita una terminal interactiva y un navegador. Cuando no puede usar el callback, la CLI lo indica y continúa con el flujo de código de dispositivo; con --no-open o en un script, usa el flujo de código de dispositivo desde el principio.

pathrule whoami muestra la cuenta con la que iniciaste sesión. pathrule logout cierra la sesión de la CLI, y pathrule logout --all también cierra la sesión de las demás interfaces de Pathrule en esta máquina, como la extensión de VS Code.

Vincular un espacio de trabajo

El espacio de trabajo es la unidad a la que Pathrule asocia el contenido. La CLI siempre vincula la carpeta desde la que la ejecutas, así que primero entra al repositorio. No hay ninguna opción que reciba una ruta.

La vía guiada lo hace todo en una sola ejecución:

cd ~/repos/my-team
pathrule setup

pathrule setup empieza pidiéndote que elijas Pathrule Cloud o Local. Cloud es el inicio administrado recomendado, con cuentas, organizaciones e inteligencia compartida. Local se ejecuta en esta máquina y no requiere cuenta. La configuración conecta el espacio de trabajo y los clientes de IA que elijas. En una Mac con Apple Silicon también ofrece el modelo en el dispositivo opcional, que puedes omitir.

La configuración de Cloud puede vincular un espacio de trabajo existente o crear uno para esta carpeta. Después, el runtime local entrega el contenido a través de la configuración y los hooks compatibles de cada cliente.

Para hacerlo paso a paso:

cd ~/repos/my-team
pathrule workspace list
pathrule workspace attach my-team

pathrule workspace attach recibe el nombre exacto del espacio de trabajo o su id. Sin argumentos, vincula tu espacio de trabajo actual. Si prefieres empezar uno nuevo, pathrule init crea uno con el nombre de la carpeta y lo vincula en un solo paso, y pathrule init my-team o pathrule workspace create my-team hacen lo mismo con el nombre que indiques. Los espacios de trabajo pertenecen a tu organización actual: pathrule org list muestra las tuyas y pathrule org use <slug> cambia de organización.

Después de vincularlo, cada vez que ejecutes un cliente de IA en esta carpeta o en una subcarpeta, el runtime sabe qué contenido de espacio de trabajo debe entregar.

En un script, pathrule setup recibe sus respuestas como opciones y necesita --yes para actuar:

pathrule setup --workspace my-team --target all --yes

Conectar tus clientes de IA

pathrule setup te pregunta qué clientes de IA usas, los instala y recuerda tu elección para este espacio de trabajo. Para conectar uno a mano:

pathrule install cursor
pathrule sync

pathrule install acepta claude, cursor, codex, windsurf o copilot y, si no indicas ningún cliente, instala los cinco. Escribe la entrada del servidor MCP de Pathrule en la configuración de nivel de usuario de ese cliente y no toca ningún otro servidor que haya ahí. GitHub Copilot recibe dos entradas, una para Copilot CLI y otra para VS Code. pathrule uninstall <client> vuelve a quitar la entrada.

pathrule sync escribe en el repositorio los archivos que leen tus clientes y actualiza el índice local de hooks. Ejecútalo en la carpeta vinculada al espacio de trabajo, después de vincularla y cada vez que quieras que esos archivos se pongan al día con el espacio de trabajo. Escribe para los clientes de IA elegidos para este espacio de trabajo en pathrule setup. Si no se eligió ninguno, escribe para los clientes cuyos archivos de Pathrule ya están en el repositorio, y para Claude Code si no hay ninguno. pathrule sync --skills copia las skills del espacio de trabajo en las carpetas de skills de tus clientes.

Qué escribe Pathrule en tu repositorio

Pathrule escribe en los lugares que cada cliente ya lee, así que no hay que configurar nada nuevo en el cliente.

Pathrule marca lo que escribe: sus archivos de instrucciones llevan un encabezado de Pathrule, y todo lo que agrega a un archivo tuyo queda dentro de un bloque marcado. Cuando un archivo de instrucciones como CLAUDE.md o AGENTS.md ya contiene tu propio contenido, Pathrule guarda tu versión como respaldo antes de escribir, o escribe dentro de su bloque marcado y deja el resto del archivo intacto. Una carpeta .pathrule en la raíz del repositorio guarda el registro de Pathrule de los archivos que administra, junto con esos respaldos. Las skills sincronizadas con pathrule sync --skills van a la carpeta de skills de cada cliente, como .claude/skills/, y cuando el repositorio tiene un .gitignore, Pathrule agrega una sección comentada que mantiene esas carpetas fuera de git hasta que la elimines.

Fuera del repositorio, pathrule install escribe las entradas MCP en la configuración de nivel de usuario de cada cliente, y la CLI guarda su sesión, su caché y su script de hooks en tu directorio de Pathrule, ~/.pathrule de forma predeterminada.

Para ver qué administra Pathrule en una carpeta sin cambiar nada, ejecuta pathrule doctor, que lista cada archivo administrado con la interfaz y la versión que lo escribió. Las páginas de cada cliente entran en más detalle: Claude Code, Codex, Cursor, Windsurf y GitHub Copilot.

Úsalo sin cuenta

Pathrule CLI también puede ejecutarse por completo en tu máquina, sin cuenta y sin nube. Dentro del proyecto:

cd ~/repos/my-project
pathrule setup --local

pathrule init --local crea un espacio de trabajo local para la carpeta actual. pathrule setup --local hace lo mismo y luego instala la entrada MCP local para todos los clientes de IA, o para uno solo con --target <client>, instala los hooks y escribe los archivos del repositorio, todo sin iniciar sesión. Tu agente escribe memorias, reglas y skills mediante las herramientas MCP de Pathrule, y tú las lees y buscas desde la terminal con --local, por ejemplo pathrule memory list --local. Consulta Trabajar sin cuenta para ver todos los comandos locales y Núcleo de código abierto para saber qué incluye la edición local.

Configuración solo con código abierto

Pathrule CLI es de código abierto bajo Apache-2.0, y el modo local lo ejecuta sin cuenta y sin ningún servicio en la nube. El modelo en el dispositivo que ofrece la configuración en una Mac con Apple Silicon es opcional: recházalo cuando la configuración te lo pregunte o quítalo más tarde con pathrule intelligence remove. Todo lo que no necesita el modelo sigue funcionando sin él. Núcleo de código abierto detalla qué es de código abierto hoy y qué es propietario.

Verificar la conexión

El doctor es el único comando que confirma la configuración de principio a fin. Solo lee; nunca cambia nada.

pathrule doctor

Revisa lo siguiente:

• Que hayas iniciado sesión y que haya una organización y un espacio de trabajo seleccionados.
• Que la carpeta actual sea la vinculada al espacio de trabajo.
• Que cada cliente de IA tenga instalada la entrada MCP de Pathrule.
• Los archivos que administra Pathrule en esta carpeta, con la interfaz y la versión que escribió cada uno. Se marca cualquier archivo escrito por otra interfaz o por una versión más nueva.

Cuando algo requiere atención, doctor indica el siguiente comando, como pathrule login o pathrule attach <workspace>. pathrule doctor --json devuelve el informe completo para un script, que además cubre la versión de Node.js y marca cualquier entrada MCP cuyo comando de inicio esté desactualizado, y termina con un código distinto de cero cuando falla alguna comprobación. Una entrada desactualizada se corrige con pathrule repair, que reescribe las entradas de Pathrule en la configuración de tus clientes, no toca ningún otro servidor y vuelve a escribir los archivos del repositorio.

Quitar Pathrule de un proyecto

Empieza con el plan de solo lectura desde el repositorio:

pathrule eject

Lista los archivos que pertenecen a Pathrule y las regiones administradas, incluida cualquier recuperación de tu contenido anterior. Revisa ese plan y luego aplícalo de forma explícita:

pathrule eject --apply

Para una carpeta vinculada a Cloud, pathrule detach desconecta la carpeta local sin eliminar el espacio de trabajo de Cloud. La extensión de VS Code también puede desvincular su carpeta.

Las integraciones nativas tienen su propia configuración registrada. Usa pathrule integrations remove <agent> para quitar una. Las entradas MCP basadas en la configuración que se instalaron con pathrule install se pueden quitar con pathrule uninstall <client>. Estas operaciones conservan los ajustes y servidores del cliente que no tienen relación con Pathrule.

Qué leer a continuación

• Referencia de comandos con todos los comandos y opciones.
• Inicio rápido para escribir tu primera memoria y ver cómo se activa el hook.
• Cómo funcionan los hooks para entender el modelo que explica qué verifica doctor.
• Descripción general de MCP para conocer las herramientas que llama el asistente una vez que el runtime está en marcha.