Pathrule CLI

O Pathrule CLI é a interface de instalação e de terminal do Pathrule. Ele é publicado no npm como @pathrule/cli sob a licença Apache-2.0, roda em macOS, Linux e Windows e hospeda, no seu shell, o servidor MCP local, o cache local e o supervisor de hooks. Ele conecta Claude Code, Codex, Cursor, Windsurf e GitHub Copilot, e se encaixa em fluxos via SSH, headless e de terminal independente.

O conteúdo e o contrato MCP são compartilhados entre os clientes, enquanto a entrega segue o canal que cada cliente expõe. Claude Code e Codex recebem hooks que incluem um hook de prompt, então o contexto chega antes de o agente agir. Cursor e GitHub Copilot recebem hooks de sessão e de ferramenta, sem hook de prompt. O Windsurf não tem hooks: ele lê um arquivo de regras gerado e acessa contexto mais profundo pelo MCP.

O que fica a cargo do Pathrule CLI

• Login. Por padrão, um código de dispositivo de uso único, que funciona do mesmo jeito no seu computador, via SSH e em qualquer máquina headless, ou login com GitHub por callback do navegador nesta máquina com --browser-callback.
• Vinculação ao espaço de trabalho. Vincula a pasta em que você executa o comando a um espaço de trabalho, para que o runtime consiga resolver o diretório de trabalho da sua sessão de IA. pathrule setup faz isso de forma guiada, e pathrule init cria e vincula um espaço de trabalho em uma única etapa.
• Instalação e sincronização dos clientes de IA. Grava a entrada MCP do Pathrule no Claude Code, Codex, Cursor, Windsurf e GitHub Copilot. pathrule sync grava no repositório os arquivos de instruções e a configuração de hooks que cada cliente lê.
• Remoção. pathrule eject mostra uma prévia da limpeza do projeto e pathrule eject --apply a aplica. Remova integrações nativas com pathrule integrations remove <agent> e entradas MCP baseadas em configurações com pathrule uninstall <client>. Veja Remover o Pathrule de um projeto.
• Sem necessidade de conta. pathrule init --local e pathrule setup --local executam o Pathrule sobre um armazenamento local, sem login e sem nuvem. Veja Trabalhar sem conta.
• O modelo no dispositivo. pathrule intelligence instala, atualiza e remove o modelo opcional no dispositivo em um Mac com Apple Silicon. Nada mais depende dele. Veja o modelo local.
• Servidor MCP. Roda localmente e é a interface com a qual seu assistente se comunica.
• Supervisor de hooks. Registra os hooks que cada cliente compatível com hooks suporta e entrega o contexto vinculado ao caminho da pasta em que o agente está trabalhando.
• Suas preferências de trabalho. pathrule me lista, ensina, explica, muda o escopo e esquece o que a User Intelligence guarda sobre você, mantido na sua máquina, e pathrule me context mostra o que um agente receberia para uma tarefa.
• Conhecimento no terminal. pathrule search, list e read funcionam no modo Local e no Cloud. O add do CLI é para espaços de trabalho Cloud; a criação local usa o Local Console, o VS Code ou o MCP.
• Diagnóstico. Um único comando somente leitura que verifica seu login, o espaço de trabalho e a vinculação da pasta, a entrada MCP de cada cliente de IA e os arquivos que o Pathrule gerencia na pasta. pathrule repair corrige entradas desatualizadas.
• Automação. Quase todos os comandos aceitam --json para uma saída estável e legível por máquina.

Todos os comandos e opções estão na referência de comandos.

Fluxo recomendado

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

pathrule setup vincula a pasta a um espaço de trabalho correspondente ou cria um, pergunta quais clientes de IA conectar, instala esses clientes e grava os arquivos que eles leem. Para criar o espaço de trabalho você mesmo, execute pathrule init my-project na pasta, ou pathrule workspace attach my-project para um que já exista. Os dois atuam na pasta atual, e nenhum deles aceita uma opção de caminho.

Depois disso, o Claude Code ou o Codex abertos em ~/repos/my-project recebem o contexto do Pathrule já no primeiro prompt. Cursor e GitHub Copilot o recebem no início da sessão e em torno das chamadas de ferramenta, e o Windsurf o lê do seu arquivo de regras e pelo MCP.

Modos de saída

O CLI tem dois modos de saída, que você alterna com --json.

• Modo humano (padrão): Linhas de status marcadas como ok, warn, error ou info, com o próximo comando a executar quando houver um. Prompts e janelas do navegador só aparecem em um terminal interativo.
• Modo JSON: Um objeto JSON por comando, para scripts, runners de CI e automação. Ele sempre traz ok, command e cwd, além de data em caso de sucesso ou um error com um code e uma message. --json está disponível nos comandos que o anunciam em --help. snapshot e eject não o suportam, e ele nunca exibe prompts nem abre o navegador.

pathrule workspace list           # human
pathrule workspace list --json    # machine readable

Um comando termina com código diferente de zero quando não fez o que você pediu, então uma etapa de CI falha por causa dele.

Comandos que abrem o navegador

Alguns fluxos existem só na nuvem e abrem o Pathrule Web no seu navegador padrão, em vez de reimplementar o console no terminal.

pathrule billing
pathrule upgrade
pathrule team open

Cada um deles imprime a URL que abriu. Com --no-open, ele imprime a URL sem abrir nada, para que você possa copiá-la de um shell remoto. O pathrule team sozinho lista no terminal os membros da organização e os convites pendentes.

Quando usar o Pathrule CLI

Use o Pathrule CLI quando você trabalha via SSH, quando quer automatizar o Pathrule em um runner de CI, quando quer experimentar o Pathrule sem conta ou simplesmente quando vive no terminal. Para navegar e editar o conhecimento dentro do editor, adicione o Pathrule para VS Code, que compartilha o mesmo login e os mesmos hooks.

O que ler em seguida

• Instalação para as formas de instalar, os fluxos de login, o que o Pathrule grava em um repositório e como removê-lo.
• Referência de comandos para todos os comandos e opções.
• Pathrule para VS Code para a interface no editor, que compartilha a mesma identidade e os mesmos hooks.
• Como os hooks funcionam para saber o que o runtime entrega ao seu assistente.