Skip to content

Getting started

Requirements

  • Node.js 20 or newer

Install rules into a project

No install needed — run it with npx:

cd your-project
npx agent-rules-kit init                       # AGENTS.md, all packs
npx agent-rules-kit init --packs core,testing  # a subset
npx agent-rules-kit init --target claude       # writes CLAUDE.md
npx agent-rules-kit init --target cursor       # writes .cursorrules
npx agent-rules-kit init --stdout              # preview only
npx agent-rules-kit list                       # show packs

Or install it as a dev dependency:

npm install -D agent-rules-kit

What it writes

A single markdown file (default AGENTS.md) with a header and one ## section per selected pack. Commit it so your whole team — and every assistant — shares the same rules. Re-run any time to update; it overwrites the target file.

Choosing a target

  • AGENTS.md — the emerging cross-tool standard many assistants read.
  • CLAUDE.md — read by Claude Code.
  • .cursorrules — read by Cursor.

You can generate more than one; just run it once per target.

As a library

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

console.log(PACKS.map((p) => p.id));      // ['core','testing',...]
const md = composeRules(['core', 'git']); // markdown you can write anywhere