PathruleReferência de comandos
Todos os comandos do Pathrule CLI, o que cada um faz e as opções que importam, do login e da configuração do espaço de trabalho ao conhecimento, ao diagnóstico e ao uso local sem conta.
Nesta página
- Opções globais
- Opções que um comando não conhece
- Saída JSON
- Códigos de saída
- Começar
- Conta e contexto
- Configuração do espaço de trabalho
- Conhecimento
- Suas preferências de trabalho e o modelo local
- Local Console e integrações com agentes
- Remover a integração do projeto
- Diagnóstico e manutenção
- Equipe e cobrança
- Ajuda e versão
- Trabalhar sem conta
- O que ler em seguida
Todos os comandos do Pathrule CLI, agrupados da mesma forma que o pathrule help os agrupa. Cada entrada diz o que o comando faz e quais opções importam. Para uma primeira configuração, comece por Instalação.
pathrule <command> [subcommand] [arguments] [options]
pathrule help
Opções globais
| Opção | O que faz |
|---|---|
--json | Mostra um único objeto JSON legível por máquina em vez da saída para humanos. Também desativa cores, prompts e janelas do navegador. |
--yes | Aceita a confirmação que setup e cache prune pedem antes de alterar qualquer coisa. |
--no-open | Nunca abre o navegador. Um comando que abriria um mostra a URL no lugar. |
--no-color | Mostra a saída sem cores. Definir a variável de ambiente NO_COLOR como 1 tem o mesmo efeito. |
--local | Executa init, setup, sync, search e os comandos memory, rule e skill sobre um armazenamento local que dispensa conta. Veja Trabalhar sem conta. |
--help, -h | Mostra a lista de comandos. |
--version, -v | Mostra a versão do CLI. |
Quando a variável de ambiente CI está como true, o CLI também pula prompts e janelas do navegador, para que um comando nunca fique esperando entrada em um runner.
Opções que um comando não conhece
O CLI não rejeita uma opção que não reconhece. A maioria dos comandos a lê como argumento comum, o que faz o comando falhar ou agir sobre o alvo errado. pathrule workspace attach --path ~/repos/app procura um espaço de trabalho chamado --path, e pathrule install --client cursor para porque --client não é nome de cliente. setup, invite, team, e memory add, rule add e skill add verificam as próprias opções e param com erro diante de uma que não conhecem. Use as opções desta página ou do pathrule help.
Saída JSON
Com --json, toda resposta é um único objeto JSON com ok, command e cwd, mais data quando o comando teve sucesso, ou error com um code e uma message quando não teve. Algumas respostas incluem next_steps com os próximos comandos a executar. O --json está disponível nos comandos que o anunciam no --help. snapshot e eject não oferecem suporte a ele, então execute esses comandos sem ele. Faça login com o pathrule login simples, já que o fluxo de login precisa mostrar um código para você.
Códigos de saída
0 significa que o comando fez o que você pediu. A maioria dos erros de uso, como um argumento faltando ou um nome de cliente desconhecido, sai com 64. Qualquer outra falha sai com 1, e pathrule doctor sai com 1 quando uma verificação falha. Em uma versão do Node.js anterior à 20.11.1, todo comando para com 78 antes de fazer qualquer coisa.
Começar
| Comando | O que faz |
|---|---|
pathrule setup | Conecta a pasta atual em uma única execução guiada. Faz seu login se necessário, sugere os espaços de trabalho da sua organização que correspondem a esta pasta (o mesmo remote git, por exemplo), associa o que você escolher ou cria um com o nome da pasta, pergunta quais clientes de IA conectar, instala esses clientes, grava os arquivos que eles leem e oferece iniciar uma primeira varredura do projeto em um deles. Em um Mac com Apple Silicon, oferece por fim o modelo no dispositivo opcional. |
pathrule init [name] | Cria um espaço de trabalho na sua organização atual, com o nome da pasta a menos que você informe um nome, e associa a pasta atual a ele. |
Sem um terminal para exibir prompts, o pathrule setup apenas mostra um plano: a organização, os espaços de trabalho correspondentes e o comando que associaria o mais adequado. Estas opções fazem o comando agir, e agir exige --yes:
--workspace <name-or-id>associa um espaço de trabalho existente.--workspace-idé a mesma opção.--create-workspacecria um espaço de trabalho com o nome da pasta. Adicione--workspace-name <name>para escolher o nome você mesmo.--select-workspace <name-or-id>torna um espaço de trabalho o atual sem associar esta pasta.--org <slug-or-id>troca de organização antes.--target <client>instala a entrada MCP paraclaude,cursor,codex,windsurf,copilotouall.
pathrule setup --workspace my-project --target all --yes
pathrule setup bootstrap --rerun varre de novo a documentação e o histórico de commits do repositório e prepara novas candidatas a memória e regra para a primeira varredura do projeto no espaço de trabalho atual.
Conta e contexto
| Comando | O que faz |
|---|---|
pathrule login | Entra com um código de uso único. O CLI mostra o código e abre a página de aprovação no navegador com o código já preenchido, ou mostra a URL para abrir em qualquer dispositivo quando não há navegador. --no-open nunca abre o navegador. --browser-callback entra com GitHub em um navegador nesta máquina e retorna por um callback local, voltando ao código quando isso não é possível. --device-code é aceito e executa o fluxo padrão com código. |
pathrule logout | Encerra a sessão do Pathrule CLI nesta máquina. --all também encerra a sessão das outras superfícies do Pathrule nesta máquina, como a extensão do VS Code. |
pathrule whoami | Mostra a conta conectada e quando a sessão expira. |
pathrule org list | Lista suas organizações com a sua função em cada uma e marca a atual com *. O pathrule org simples faz o mesmo. |
pathrule org current | Mostra a organização atual e a sua função nela. |
pathrule org use <slug-or-id> | Troca a organização atual. |
pathrule workspace list | Lista os espaços de trabalho da organização atual e marca o atual com *. O pathrule workspace simples faz o mesmo. |
pathrule workspace current | Mostra o espaço de trabalho atual. |
pathrule workspace use <name-or-id> | Torna um espaço de trabalho o atual sem associar uma pasta. |
pathrule workspace create <name> | Cria um espaço de trabalho e associa a pasta atual a ele. |
pathrule workspace attach [name-or-id] | Associa a pasta atual a um espaço de trabalho existente, identificado pelo nome exato ou pelo id. Sem argumento, associa o espaço de trabalho atual. Não existe opção de caminho: execute o comando dentro da pasta. |
pathrule workspace detach [name-or-id] | Remove a associação da pasta com o espaço de trabalho nesta máquina. O espaço de trabalho e o conteúdo dele continuam no Pathrule. |
pathrule workspace inspect | Mostra o espaço de trabalho atual em detalhes: a organização e o plano, onde está associado, o remote git, quantas memórias, regras e skills contém, o uso do plano, quais clientes de IA estão configurados e a atividade recente. |
Associar, criar, init e workspace use também tornam esse espaço de trabalho o atual. Comandos como memory, rule, skill, search e sync atuam sobre o espaço de trabalho atual.
Configuração do espaço de trabalho
| Comando | O que faz |
|---|---|
pathrule attach [name-or-id] | O mesmo que workspace attach. |
pathrule detach [name-or-id] | O mesmo que workspace detach. |
pathrule install [client] | Grava a entrada do servidor MCP do Pathrule na configuração de usuário do próprio cliente de IA e não mexe em nenhum outro servidor dela. O cliente é claude (ou claude-code), cursor, codex, windsurf, copilot (ou github-copilot), ou all, que é o padrão. O GitHub Copilot recebe duas entradas, uma para o Copilot CLI e outra para o VS Code. |
pathrule uninstall [client] | Remove a entrada MCP do Pathrule da configuração desse cliente, ou dos cinco. |
pathrule sync | Grava no repositório os arquivos que seus clientes de IA leem: arquivos de instruções, configuração de hooks e o índice local de hooks. Execute na pasta associada ao espaço de trabalho. --skills sincroniza apenas as skills do espaço de trabalho nas pastas de skills dos seus clientes. --local sincroniza um espaço de trabalho sem conta. |
pathrule mcp run | Inicia o servidor MCP local do Pathrule pela entrada e saída padrão. É esse o comando que a entrada MCP gravada pelo pathrule install executa, então quem o roda é o seu cliente de IA, não você. |
O pathrule sync grava arquivos para os clientes de IA escolhidos para este espaço de trabalho no pathrule setup. Quando nenhum foi escolhido, grava para os clientes cujos arquivos do Pathrule já estão no repositório, e para o Claude Code quando não há nenhum. O CLAUDE.md e a entrada de hook do Claude Code são atualizados a cada sincronização. Instalação lista cada arquivo. Para tirar o Pathrule de um repositório, veja Remover o Pathrule de um projeto.
Conhecimento
| Comando | O que faz |
|---|---|
pathrule search <query> | Busca memórias, regras e skills no espaço de trabalho atual. --type memory,rule restringe os tipos, --path /apps/api restringe a um caminho e --limit <n> limita os resultados. |
pathrule memory list | Lista memórias. --path ou um caminho no início restringe a lista, então pathrule memory list /apps/api e pathrule /apps/api memory list são equivalentes. --limit <n> limita a lista. |
pathrule memory read <id-or-title> | Mostra uma memória. Passe --print para mostrar conteúdo longo por completo no terminal. |
pathrule memory add | Grava uma memória com --path </node/path> --title <title>. O corpo vem de --body, da entrada padrão ou do seu editor (VISUAL ou EDITOR) quando você não informa nenhum dos dois. --allow-duplicate pula a verificação de duplicatas. |
pathrule rule list, read, add | O mesmo para regras. rule add recebe --name no lugar de --title, além de --priority (high, medium ou low, padrão medium) e --scope (project, folder ou file_type, padrão project). |
pathrule skill list, read, add | O mesmo para skills. skill add recebe --name e um --description opcional. |
pathrule refresh list | Lista as tarefas de atualização abertas, os pedidos para atualizar conhecimento que ficou desatualizado. --include-in-progress inclui as já assumidas e --limit <n> limita a lista. |
pathrule refresh claim [id] | Assume uma tarefa de atualização, a próxima aberta quando você não informa um id, e mostra o resumo dela. |
pathrule refresh resolve <id> --status applied | Fecha uma tarefa de atualização como applied ou rejected. --note "<text>" registra o motivo. |
pathrule snapshot | Captura um inventário da pasta atual, com a árvore de arquivos, os manifests e pequenos trechos da documentação, a branch git e o histórico recente, e envia para o espaço de trabalho. Não lê o conteúdo de nenhum outro arquivo. --dry-run mostra o inventário sem enviar e --notes "<text>" anexa uma nota. |
pathrule snapshot list [n] | Lista os snapshots mais recentes do espaço de trabalho. |
Suas preferências de trabalho e o modelo local
| Comando | O que faz |
|---|---|
pathrule me list | Lista o que a User Intelligence guarda sobre a sua forma de trabalhar, tanto o que já está em uso quanto o que ainda não está. O pathrule me simples faz o mesmo. |
pathrule me teach "<sentence>" | Ensina uma preferência com as suas próprias palavras. Requer o modelo opcional no dispositivo. |
pathrule me explain <id> | Mostra uma preferência com as evidências por trás dela. O id é o id curto que o me list mostra. |
pathrule me scope <id> | Restringe uma preferência ao espaço de trabalho em que você executa o comando. --everywhere faz com que ela valha em todos os espaços de trabalho. |
pathrule me forget <id> | Deixa de usar uma preferência e a mantém como rejeitada, para que as mesmas evidências não a tragam de volta. --delete a remove por completo. |
pathrule me context "<task>" | Mostra o que um agente receberia para essa tarefa e quais preferências ficaram de fora, e por quê. |
pathrule intelligence status | Mostra se o modelo no dispositivo está instalado, a versão dele e se há atualização disponível. O pathrule intelligence simples faz o mesmo. |
pathrule intelligence install | Configura o runtime local de que o modelo precisa, depois baixa o modelo e verifica o checksum antes de ativá-lo. Requer um Mac com Apple Silicon. |
pathrule intelligence update | Instala um modelo mais novo quando houver. Se a atualização falhar, o modelo que você tinha continua no lugar. |
pathrule intelligence remove | Remove o modelo. Tudo o que não depende dele continua funcionando como antes. |
Local Console e integrações com agentes
| Comando | O que faz |
|---|---|
pathrule ui | Abre o Local Console, que dispensa conta, para conhecimento, atividade e Local Signals. --port, --no-open e --json controlam como ele abre. |
pathrule integrations | Configuração interativa para Claude Code e Codex. Fora de um terminal interativo, lista a configuração. |
pathrule integrations add claude codex --local --dry-run | Mostra uma prévia de uma integração nativa sem gravar nada. Escolha --cloud para o modo Cloud. |
pathrule integrations list | Lista os agentes detectados e as integrações registradas. |
pathrule integrations doctor | Verificações somente leitura da integração instalada. |
pathrule integrations repair | Reaplica as integrações do Pathrule registradas. |
pathrule integrations remove <agent> | Remove a integração registrada. |
pathrule telemetry | Mostra a preferência de telemetria e se este CLI pode enviar dados. |
pathrule telemetry enable | Ativa o envio de eventos anônimos de uso em um CLI gerenciado com login feito. |
pathrule telemetry disable | Desativa esses eventos. |
Veja Local Console e Integrações nativas com agentes.
Remover a integração do projeto
pathrule eject mostra um plano somente leitura para remover os arquivos e as regiões gerenciadas que pertencem ao Pathrule no repositório atual. pathrule eject --apply executa o plano depois que você o revisa. O eject não tem versão com --json. Os plugins nativos são removidos com pathrule integrations remove <agent>.
Diagnóstico e manutenção
| Comando | O que faz |
|---|---|
pathrule status | Mostra a conta conectada, a organização e o plano atuais, o espaço de trabalho atual e se esta pasta está associada. |
pathrule doctor | Executa verificações somente leitura: login, organização, espaço de trabalho, se esta pasta está associada, se cada cliente de IA tem a entrada MCP do Pathrule e os arquivos que o Pathrule gerencia nesta pasta, com a superfície e a versão que gravou cada um. Indica o próximo comando quando algo precisa de atenção. Com --json, o relatório também cobre a versão do Node.js e aponta uma entrada MCP cujo comando de inicialização está desatualizado. --bundle grava um arquivo de suporte com credenciais e caminhos locais ocultados. |
pathrule repair | Reescreve as entradas MCP do Pathrule desatualizadas nas configurações dos seus clientes de IA, sem mexer nos outros servidores, grava de novo os arquivos do repositório e informa o que mudou. |
pathrule preflight <action> | Verifica se o seu plano permite uma ação antes de você tentá-la. A ação é create_workspace, write_memory, write_rule, write_skill, sync_agents ou materialize_skills. |
pathrule cache prune | Lista as pastas de cache local obsoletas sem removê-las. --yes as remove. |
pathrule config get <key> | Lê uma preferência: update.policy, telemetry.enabled ou telemetry.id. |
pathrule config set <key> <value> | update.policy manual desativa a verificação diária de atualização, enquanto notify e auto a mantêm. telemetry.enabled false desliga a telemetria anônima de uso. Definir a variável de ambiente NO_TELEMETRY como 1 faz o mesmo para uma execução ou um shell. |
pathrule config reset telemetry-id | Substitui o id de telemetria por um novo. |
pathrule update | Verifica se há um CLI mais novo e mostra o comando que o instala. Nunca instala nada por conta própria. |
Uma vez por dia, uma execução interativa também verifica se há um CLI mais novo e mostra um aviso de uma linha com o comando de atualização. Ele só menciona uma versão mais nova que a sua.
O CLI local independente não envia telemetria. Um CLI gerenciado com login feito só envia eventos anônimos de uso depois que você ativa com pathrule telemetry enable. Os eventos não carregam código, caminhos, prompts, conhecimento, e-mail nem ids de conta e de espaço de trabalho. Desative com pathrule telemetry disable; NO_TELEMETRY=1, DO_NOT_TRACK=1 e CI mantêm a telemetria desligada.
Equipe e cobrança
| Comando | O que faz |
|---|---|
pathrule team | Lista os membros e os convites pendentes da organização atual, ou de --org <slug-or-id>. pathrule team open abre o Pathrule Web, onde os membros são gerenciados. |
pathrule invite <email> | Convida um colega para a organização atual como editor. --role define admin, editor ou viewer, e --org e --workspace definem a organização e o espaço de trabalho. Informa se o e-mail de convite foi enviado e como o convite afeta seus assentos. |
pathrule billing | Abre a cobrança da organização no Pathrule Web. |
pathrule upgrade | Abre a cobrança para escolher um plano. |
Ajuda e versão
| Comando | O que faz |
|---|---|
pathrule help | Mostra a lista de comandos. |
pathrule version | Mostra a versão do CLI, o mesmo que --version. |
Trabalhar sem conta
O Pathrule CLI funciona com um armazenamento local, sem conta e sem nuvem. Execute estes comandos dentro do projeto:
cd ~/repos/my-project
pathrule init --local
pathrule setup --local
pathrule init --local [name] cria um espaço de trabalho local para a pasta atual, mantido nesta máquina, e reaproveita o que já cobre a pasta, se houver. pathrule setup --local faz o mesmo e depois instala a entrada MCP local para todos os clientes de IA, ou para um só com --target <client>, instala os hooks e grava os arquivos do repositório, tudo sem login. --workspace-name <name> dá nome a um novo espaço de trabalho. Opções que exigem conta, como --org ou --workspace, param com erro.
Em um espaço de trabalho local, seu agente de IA grava memórias, regras e skills pelas ferramentas MCP do Pathrule. No terminal, você as lê e busca com --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 e skill add exigem conta. Com --local, eles avisam isso e não alteram nada. Veja Núcleo de código aberto para saber o que a edição local inclui.
O que ler em seguida
- Instalação para a primeira configuração, o que o Pathrule grava em um repositório e como removê-lo.
- Pathrule CLI para saber pelo que o CLI é responsável e quando usá-lo.
- User Intelligence para saber o que o
pathrule megerencia.