Skip to content

JulianBerger/cursor-rules-to-agents-md

Repository files navigation

cursor-rules-to-agents-md

Convert .cursor/rules into a standardized AGENTS.md file. The CLI supports inline rule embedding or a reference-only mode, and it handles existing AGENTS.md files with overwrite/append logic.

Usage

Interactive mode (prompts for output mode and write behavior when needed):

npx cursor-rules-to-agents-md
pnpx cursor-rules-to-agents-md
bunx cursor-rules-to-agents-md

Inline mode:

Will embed your rule files inline in the AGENTS.md file.

npx cursor-rules-to-agents-md --mode inline
pnpx cursor-rules-to-agents-md --mode inline
bunx cursor-rules-to-agents-md --mode inline

Reference mode:

Will reference your rule files via @ syntax in the AGENTS.md file.

npx cursor-rules-to-agents-md --mode reference
pnpx cursor-rules-to-agents-md --mode reference
bunx cursor-rules-to-agents-md --mode reference

Reference output format:

## Ruleset: TypeScript Rules

**Applies to (globs):**

- `src/**/*.ts`
- `tests/**/*.ts`

**Includes:**

- `@src/tests/fixtures/repo-a/.cursor/rules/alpha.md`

---

Overwrite vs append behavior when AGENTS.md exists:

# Default is append when no markers exist.
bunx cursor-rules-to-agents-md --mode inline

# Force overwrite.
bunx cursor-rules-to-agents-md --mode inline --overwrite

Custom rules can be added below the insert marker:

<!-- cursor-rules-to-agents-md - INSERT CUSTOM RULES BELOW -->

About

Convert .cursor/rules into a standardized AGENTS.md file

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors