AGENTS.md Generator

Fill the form and instantly get a rules file — in the standard section structure — that Cursor, Claude Code, Codex, and Copilot read. Copy and download, all in your browser.

Output language

Choosing a preset auto-fills the stack, commands, and code style fields.

Sections to include

AGENTS.md
# my-app

## Project overview

A small web service that does one thing well.

**Tech stack:** Node.js, TypeScript, npm

## Setup commands

Install:

```bash
npm install
```

- **Dev server:** `npm run dev`
- **Build:** `npm run build`
- **Test:** `npm test`
- **Lint / format:** `npm run lint`

## Code style

- Indent with 2 spaces
- Use TypeScript strict mode; no `any`
- Format with Prettier, lint with ESLint
- camelCase for variables, PascalCase for types
- Prefer named exports over default exports

## Testing instructions

Run tests with `npm test`.

Always run the test suite before committing. Add or update tests for any behavior change.

## Project structure

```text
src/        application source
src/lib/    pure logic (no side effects)
test/       unit tests
dist/       build output (generated, do not edit)
```

## Commit & PR conventions

- Follow Conventional Commits (feat:, fix:, chore:, docs:)
- Keep the subject line under 72 characters
- Open one PR per logical change; describe what and why

## Security

- Never commit secrets; use environment variables (.env is gitignored)
- Do not log tokens, passwords, or PII
- Validate and sanitize all external input

## Do not

- Do not edit files in dist/ or build/ (generated)
- Do not add new dependencies without discussion
- Do not commit directly to main; open a PR

Tip: keep AGENTS.md as the source of truth and symlink the rest — ln -s AGENTS.md CLAUDE.md

Guide · FAQ · bal.pe.kr

See the Guide for the AGENTS.md standard, the FAQ, and About for how it works. Last updated 2026-07-11.