cursor-rules
Kabi10 · Kabi10/cursor-rules
Provides a CLI tool that scans project dependencies and auto-generates tailored AI editor rules as AGENTS.md or .mdc files for Cursor, Copilot, Codex, and Claude Code.
Detect your stack and auto-generate AI editor rules - AGENTS.md (Cursor, Copilot, Codex, Claude Code) or Cursor .mdc. npx cursor-compose
See it in action
From the author's READMECLI tool detecting project stack and generating coding rules
From the author's README Kabi10 ·Source
What you can do with it
- Quickly set up AI agent rules for a new project by automatically detecting the technology stack.
- Ensure consistent AI coding assistant behavior across multiple tools like Cursor and Claude Code.
- Generate updated rules when project dependencies change without manual editing.
Safety check
No risky patterns found in the files we scanned.
Automated scan of the repo files. Always review code you run.
From the README
cursor-compose
Stop hand-writing AI coding rules. Detect your stack, generate them — for every tool.
One command scans your project, detects your frameworks, and writes a tailored rules file. Output a portable AGENTS.md (read by Cursor, Copilot, Codex & Claude Code) or Cursor's native .cursor/rules/*.mdc — from one source.
npx cursor-compose --agents # → AGENTS.md, works across every major AI editor
Why
Everyone is pasting the same recycled rules files between projects. They go stale, they don't match your actual stack, and every editor wants its own format.
cursor-compose reads your real dependencies (package.json, requirements.txt, pubspec.yaml) and composes a rules file from modular, stack-specific building blocks — and writes it as the portable AGENTS.md standard so the same source works in Cursor, Copilot, Codex and Claude Code. Zero config to start.
Usage
# In your project root:
npx cursor-compose # default → per-module .cursor/rules/*.mdc
npx cursor-compose --agents # → AGENTS.md (portable, cross-tool)
npx cursor-compose --all # → both .mdc and AGENTS.md, one pass
It will:
- Scan your project for dependency files.
- Show the modules it detected and let you toggle optional ones.
- Write your chosen output(s).
No install, no config file required.
Flags
| Flag | Output |
|---|---|
| (default) | per-module .cursor/rules/*.mdc (current Cursor format) |
--agents | AGENTS.md at repo root — portable across Cursor, Copilot, Codex, Claude Code |
--all | both .mdc and AGENTS.md in one pass |
--legacy | a single .cursorrules file |
--yes, -y | non-interactive: use detected modules, no prompts (great for CI/scripts) |
-h, --help | show help |
AGENTS.md is safe to hand-edit
The generated content lives between managed markers:
# AGENTS.md
...generated from your stack...
## Your own notes (preserved on regenerate)
Re-running --agents only replaces the managed block — anything you add outside it is kept.
What it detects
| Auto-detected | From |
|---|---|
| Next.js + TypeScript | package.json |
| Supabase | package.json |
| Drizzle ORM | package.json |
| shadcn / Radix UI | package.json |
| FastAPI | requirements.txt |
| Flutter | pubspec.yaml |
Core conventions always load by default.
Optional modules
Toggle these on during the interactive prompt:
saas— multi-tenancy, billing, auth patternsecommerce— cart, checkout, payment flowsclaude-code—CLAUDE.md/ documentation conventionsagentic— agent & tool-calling patterns
Requirements
- Node.js 18+
Roadmap
-
cursor-compose check— CI command that fails the build when your committed rules drift from your actual dependencies. - More stacks (Django, Rails, SvelteKit, Expo).
Want a stack supported? Open an issue or send a PR — adding a module is just a markdown file (see CONTRIBUTING.md).
How it works
src/
cli.js # interactive prompt + orchestration + flags
detect.js # reads dependency files → detected modules
compose.js # assembles selected modules; writes .mdc / .cursorrules / AGENTS.md
frontmatter.js # Cursor .mdc YAML frontmatter (not used for AGENTS.md)
modules/ # one .md per framework — the rule building blocks
patterns/ # reusable code-organization patterns
Contributing
New modules are welcome and easy — drop a markdown file in modules/. See CONTRIBUTING.md.
License
MIT