Skip to content
Start a projectStart

AGENTS.md

The map and the house rules, at the root of the project. Your agent reads it before it changes code.

What’s in it

  • The map: each app and package, and what belongs where.
  • The commands: pnpm dev, pnpm db:local, pnpm test and the others, with what each does.
  • The rules: where code goes, how pages render, how data and IDs work, auth and permissions, text and languages, environment variables, style.
  • Troubleshooting: the few errors people hit, and their fix.
  • The skills: which recipe to use for which change.

The rules, a sample

### Where code goes

- Queries on app tables live in packages/api/src/services. Server actions,
  REST routes and MCP tools all call the services; none of them query the
  database themselves.
- A new API endpoint is an operation: skill add-operation. It gives the
  REST route, the MCP tool and the OpenAPI entry together.
- A new table: skill add-table. A new page: skill add-page.

One rule closes every change: before the agent says it’s done, it runs pnpm lint, pnpm typecheck and pnpm test, and fixes what they report.

One file for every agent

CLAUDE.md holds one line, @AGENTS.md, so Claude Code reads the same rules as Codex and Cursor. The web app has its own apps/web/AGENTS.md for the rules that only apply there.

Run one command. The CLI asks the rest, and your agent takes it from there.

pnpm create turbinekit my-app
See the prompt

Paste it into an agent that can run commands, such as Claude Code, Codex or Cursor.

Create a new TurbineKit project with me.

TurbineKit (https://turbinekit.dev) is an open-source Turborepo and Next.js starter. Its CLI, create-turbinekit, needs Node.js 24 and pnpm 10 (run `corepack enable` once).

1. Run `pnpm dlx create-turbinekit --help` to see its options.
2. Ask me its questions one at a time, with their defaults: the folder, the product name, one sentence about the product, the company or legal name, the contact email, the languages and the modules. Skip what I have already told you.
3. The CLI only asks questions in an interactive terminal, so run it with my answers as options and `--yes`. Show me the command before you run it.
4. In the new folder, read AGENTS.md. Then do "1. Minimal setup" in SETUP.md, and tick each box you finish.
5. Tell me the URL of the running app, and which services SETUP.md lists next.

No sign-up, no API keys. Needs Node.js 24 and pnpm 10.