GuardRail local

A CLI do GuardRail não escolhe nem hospeda a IA do cliente. Ela apenas prepara o playbook, executa o comando local configurado e valida as evidências antes de gerar o relatório.

Instalação para desenvolvimento

Na pasta deste projeto, execute npm link. Depois, em qualquer repositório local, execute guardrail init.

Configuração do executor

Execute uma vez guardrail connect --command "sua-ia --prompt {prompt}". O comando pode usar {workspace}, {prompt} e {output}. Para integrações automáticas, a IA pode gravar no {output} um JSON com findings. No modo universal, ela apenas executa o prompt e gera o PDF padrão em docs/security-audit/; o GuardRail reconhece esse resultado ao executar guardrail finalize.

Auditoria

No repositório que será auditado: use guardrail audit para integração por CLI, ou guardrail prepare, execute sua IA normalmente e termine com guardrail finalize.

Os resultados são gravados em docs/security-audit/relatorio-auditoria-seguranca.pdf e docs/security-audit/achados-verificados.json.

OpenCode

Dentro do repositório que será auditado, conecte uma única vez com guardrail connect opencode. Depois use apenas guardrail audit. O GuardRail usa opencode run no diretório do projeto e reconhece o PDF que o OpenCode gerar.

Codex

No repositório auditado, configure a integração local uma vez:

guardrail init
guardrail connect codex

Reinicie o Codex e peça, por exemplo: Execute uma auditoria GuardRail com o perfil full neste projeto. A integração MCP expõe todos os perfis atuais (full, api, frontend, secrets e infra), além de validar e gerar os relatórios ao fim da análise.

Instalação pelo npm

Depois da publicação, instale a CLI sem usar npm link:

npm install --global guardrail-local

Ou execute-a sem instalação global:

npx guardrail-local init
npx guardrail-local connect opencode
npx guardrail-local audit

Para usá-la como dependência de desenvolvimento de um projeto:

npm install --save-dev guardrail-local
npx guardrail init

Consulte o guia completo da CLI para todos os comandos, o contrato do JSON de saída, o fluxo manual e a solução de problemas.