AGENTS.md

1# agentsync
2 
3agentsync converts between AI coding-agent rule files (AGENTS.md, CLAUDE.md, .cursorrules, Copilot, Windsurf) and can scaffold a fresh AGENTS.md. The same engine in src/core/agentsync.js powers both the CLI and the browser playground.
4 
5## Build & test commands
6 
7- Install: `no install needed (Node 18+, zero dependencies)`
8- Dev server: `npm run web   # serves the playground at http://localhost:5173`
9- Test: `npm test`
10 
11Always run the test and lint commands before finishing a task.
12 
13## Architecture
14 
15- `src/core/agentsync.js` is the engine and the single source of truth. It imports nothing.
16- `bin/agentsync.mjs` is the CLI; `web/` is the browser playground. Both import the engine directly — keep it dependency-free and isomorphic (must run in Node and the browser).
17- Adding a tool format = add an entry to `FORMATS`, a branch in `parse()`, and a renderer in `RENDERERS`. Nothing else should need to change.
18- Things that don't translate between tools (Cursor `globs`, Claude `@imports`) must surface as `warnings`, never be silently dropped.
19 
20## Code style & conventions
21 
22- Match the style of surrounding code; do not reformat unrelated lines.
23- Prefer small, focused changes and clear names over cleverness.
24- Write idiomatic JavaScript (ESM, zero-dependency). Do not add runtime dependencies.
25- Add or update a case in `test/run.mjs` for any behavior change.
26 
27## Before opening a PR
28 
29- [ ] Tests and lint pass locally.
30- [ ] No unrelated files changed.
31- [ ] Public APIs and docs updated if behavior changed.
32