Skip to content

Começar

Requisitos

  • Node.js 20 ou superior

Instalar regras num projeto

Não precisa de instalação — corre com npx:

cd o-teu-projeto
npx agent-rules-kit init                       # AGENTS.md, todos os packs
npx agent-rules-kit init --packs core,testing  # um subconjunto
npx agent-rules-kit init --target claude       # escreve CLAUDE.md
npx agent-rules-kit init --target cursor       # escreve .cursorrules
npx agent-rules-kit init --stdout              # apenas pré-visualizar
npx agent-rules-kit list                       # mostrar packs

Ou instala como dependência de desenvolvimento:

npm install -D agent-rules-kit

O que escreve

Um único ficheiro markdown (por defeito AGENTS.md) com um cabeçalho e uma secção ## por cada pack selecionado. Faz commit para toda a equipa — e todos os assistentes — partilharem as mesmas regras. Corre outra vez quando quiseres atualizar; sobrescreve o ficheiro de destino.

Escolher um destino

  • AGENTS.md — o standard cross-tool emergente que muitos assistentes leem.
  • CLAUDE.md — lido pelo Claude Code.
  • .cursorrules — lido pelo Cursor.

Podes gerar mais do que um; corre uma vez por destino.

Como biblioteca

import { composeRules, PACKS } from 'agent-rules-kit';

console.log(PACKS.map((p) => p.id));      // ['core','testing',...]
const md = composeRules(['core', 'git']); // markdown para escreveres onde quiseres