Início rápido

Comece a partir de um repositório local e do agente que você já usa. O CLI é a interface de instalação e de terminal do Pathrule. Ele conecta os agentes compatíveis no macOS, Linux ou Windows, e o mesmo conhecimento do espaço de trabalho fica acessível pela extensão do VS Code e via MCP. O modelo opcional no dispositivo tem requisitos de plataforma próprios.

Se quiser primeiro explorar um projeto local pequeno, siga o Espaço de trabalho de exemplo. Você mesmo cria e edita esse projeto.

1. Instale um runtime

Instale o CLI com Node.js 20.11.1 ou mais recente:

npm i -g @pathrule/cli

• O CLI executa o Pathrule no terminal, via SSH e em automações. Veja os requisitos detalhados em Instalação do CLI.
• A extensão do VS Code permite navegar pelo conhecimento e editá-lo no editor, e também pode conectar seus clientes de IA. Veja Pathrule para VS Code.

Você pode usar os dois com o mesmo conhecimento do espaço de trabalho. No Cloud, eles se conectam pela sua conta. O uso local do CLI não exige conta.

2. Entre

O pathrule setup pede que você escolha Cloud ou Local. O Cloud faz você entrar na sua conta para compartilhar o conhecimento do espaço de trabalho. O Local não exige conta. Use pathrule setup --local para escolher Local diretamente e pular o login. Local ou Cloud compara as duas opções. Siga para o passo 3 para iniciar a configuração.

No Cloud, você também pode entrar separadamente com um código de uso único, seja em um desktop, via SSH ou em uma máquina sem interface gráfica:

pathrule login

O CLI exibe o código e abre a página de aprovação com ele já preenchido. Se a máquina não tiver navegador, abra a URL exibida em qualquer dispositivo, digite o código e aprove. Para usar o fluxo de callback do navegador nesta máquina, execute pathrule login --browser-callback.

Os dois fluxos deixam você conectado, com uma sessão que o runtime mantém renovada em segundo plano.

3. Crie um espaço de trabalho

O espaço de trabalho é a unidade à qual o Pathrule vincula o conteúdo. Ele corresponde a um repositório ou a um pequeno grupo de repositórios na sua máquina.

No CLI, tudo acontece na pasta em que você o executa, então entre primeiro no repositório. O caminho guiado cria ou anexa o espaço de trabalho e conecta seus clientes de IA de uma só vez:

cd ~/repos/my-team
pathrule setup

O setup mostra sua organização, sugere espaços de trabalho correspondentes ou cria um para esta pasta e pergunta quais clientes de IA compatíveis devem ser conectados. Em seguida, ele pode oferecer uma primeira varredura do projeto, feita pelo seu agente, que propõe memórias, regras e skills para você aprovar. Para um espaço de trabalho mantido nesta máquina, sem conta, execute pathrule setup --local; veja a configuração local.

Para configurar o Cloud manualmente, o pathrule init cria um espaço de trabalho com o nome da pasta e anexa a pasta a ele. Para anexar um espaço de trabalho Cloud existente, use o nome ou o id:

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

Não existe opção que receba um caminho: o CLI sempre anexa a pasta atual. Depois, conecte seus clientes com pathrule install <client> e pathrule sync, como descrito em Instalação do CLI. O runtime usa esse mapeamento para associar o diretório atual a um espaço de trabalho.

4. Escreva sua primeira memória

O jeito mais rápido de confirmar que está tudo conectado é escrever uma memória e depois abrir seu assistente no escopo que ela cobre. Neste guia, coloque a memória na raiz do espaço de trabalho.

Title: Our database is Postgres on Supabase
Body:
- All queries should treat row level security as the source of truth.
- Do not bypass RLS with a service key in user facing code.
- Migrations live in supabase/migrations and run through CI.

No terminal, em um espaço de trabalho Cloud, a memória se resume a um comando. Sem --body, o CLI abre seu editor (VISUAL ou EDITOR) para o corpo; você também pode passar --body ou enviar o texto por pipe.

pathrule memory add --path / --title "Our database is Postgres on Supabase"

Em seguida, execute pathrule sync no repositório para que os arquivos e o índice local lidos pelos seus clientes incluam a nova memória.

No VS Code, use New Memory… na view do Pathrule. Em um espaço de trabalho local, escreva no Local Console ou peça ao seu agente para salvá-la pelas ferramentas MCP do Pathrule. O CLI lista, lê e pesquisa o conhecimento local, mas não o adiciona.

5. Veja o hook disparar

Abra o Claude Code ou o Codex no diretório que você anexou ao espaço de trabalho. Inicie um novo turno e faça qualquer pergunta que envolva a área coberta pela memória.

Quando você envia o prompt, o hook do Pathrule lê o recorte em cache daquele caminho, formata as memórias e regras relevantes e as entrega ao agente antes da primeira chamada de ferramenta. A memória aparece na área de contexto que o seu agente exibe, sem nenhuma ida e volta extra no meio da tarefa.

Cursor e GitHub Copilot não têm hook de prompt: o Pathrule chega até eles por hooks de sessão e de ferramenta, pelos arquivos de instruções e via MCP. O Windsurf não tem hooks e usa o arquivo de regras para iniciar a sessão e o MCP para contexto mais aprofundado, então verifique esses clientes pelos respectivos guias: Cursor, GitHub Copilot e Windsurf.

Se nada aparecer, execute o doctor.

pathrule doctor

O doctor verifica seu login, o espaço de trabalho e se esta pasta está anexada a ele, a entrada MCP de cada cliente de IA e os arquivos que o Pathrule gerencia na pasta, e indica o próximo comando para tudo o que precisar de atenção. Uma entrada de cliente desatualizada é corrigida com pathrule repair.

6. Adicione uma regra

Memórias são fatos. Regras são restrições. Adicione uma regra no mesmo caminho. Em um espaço de trabalho Cloud, pelo terminal:

pathrule rule add --path / --name "No service key in browser code" --priority high --scope folder \
  --body "Never use the SUPABASE_SERVICE_ROLE_KEY in any file under apps/web. Use the anon key plus row level security."

Você também pode usar New Rule… na extensão do VS Code ou pedir ao seu agente para salvar a regra.

Abra o Claude Code de novo. A regra chega junto com a memória. A prioridade high a coloca perto do topo. Entregue como contexto, uma regra é uma exigência que o agente é instruído a seguir, não um bloqueio. Uma regra também pode trazer uma restrição executável: um agente pode propor uma, ela fica armazenada como proposta e não é aplicada, e só depois que uma pessoa a aprova o hook pré-ferramenta pode bloquear uma edição correspondente, nos clientes cujos hooks de ferramenta respeitam essa decisão. Veja Regras como guardrails.

O que ler em seguida

• Conceitos principais, para o modelo de dados por trás de memórias, regras e skills.
• Como os hooks funcionam, para entender o que acontece entre o cache e o agente.
• Visão geral do MCP, para as ferramentas que seu assistente usa para ler e escrever conteúdo.
• Referência de comandos do CLI, com todos os comandos do Pathrule CLI.