Does this assume TypeORM or Prisma?
Neither specifically. Add one line to the notes in the generator naming your ORM and its migration commands so the agent uses them.
NestJS brings Angular-style modules and dependency injection to the server. The rules keep an agent inside that structure: the right module, a DTO for every input, and tests that use the testing module.
# AGENTS.md
Project: nestjs-api. A NestJS backend API with PostgreSQL.
This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.
## Stack
- Language: TypeScript
- Framework: NestJS
- Database: PostgreSQL
- Hosting: AWS
- Tests: Jest
- Package manager: npm
## Commands
Run these from the repository root.
- Install dependencies: `npm ci`
- Run locally: `npm run start:dev`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `npx jest src/path/to/file.spec.ts`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npm run format`
## Project layout
- `src/<feature>/`: One folder per feature module: module, controller, service, DTOs, entities
- `src/common/`: Shared guards, interceptors, pipes and filters
- `src/config/`: Typed configuration via @nestjs/config
- `test/`: End-to-end tests (test:e2e)
## Code style
- Indent with 2 spaces. Never tabs.
- TypeScript runs in strict mode. Do not use `any`; use `unknown` and narrow it, or write the real type.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.
- Keep each change small and focused on one concern. Split unrelated fixes into separate commits.
## Working rules
- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
## Product constraints
- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.
## Project-specific notes
- Every new feature is a module with its own controller and service, created with `npx nest g resource <name>`.
- Every request body, query and param uses a DTO class with class-validator decorators; the global `ValidationPipe` runs with `whitelist: true`.
- Controllers only map HTTP to service calls. Business logic and data access live in services.
- Use constructor injection through Nest providers; never instantiate services with `new`.
- Read configuration through `ConfigService`, never `process.env` directly in feature code.
- Unit tests build a `Test.createTestingModule` and mock providers; e2e tests run with `npm run test:e2e`.
- Throw Nest HTTP exceptions (`NotFoundException`, `ForbiddenException`) instead of returning error objects.
## Project phase
This project is in active development. Follow the patterns that already exist; consistency beats novelty.
# CLAUDE.md
@AGENTS.md
## Claude Code
- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
# GEMINI.md
@./AGENTS.md
## Gemini CLI
- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
# Copilot instructions
Project: nestjs-api. A NestJS backend API with PostgreSQL.
The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.
## Stack
- Language: TypeScript
- Framework: NestJS
- Database: PostgreSQL
- Hosting: AWS
- Tests: Jest
- Package manager: npm
## Commands
- Install dependencies: `npm ci`
- Run locally: `npm run start:dev`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `npx jest src/path/to/file.spec.ts`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npm run format`
## Working rules
- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---
# Project rules
The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.
Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.
Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).
These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.
The preset describes a a NestJS backend API with PostgreSQL. Its AGENTS.md is 51 non-empty lines with 8 exact commands, 4 key directories, and 7 stack-specific rules on top of the shared working rules.
npm ci, npm run start:dev, npm run build, npm test, npx jest src/path/to/file.spec.ts, npm run lint, npx tsc --noEmit, npm run format.src/<feature>/, src/common/, src/config/, test/.When an agent writes new UserService() inside a controller, it bypasses dependency injection, breaks mocking in tests and duplicates state. NestJS only works as designed if every dependency comes through a provider.
Without whitelist, extra properties in a request body pass straight through to the ORM, enabling mass assignment. DTOs plus the pipe setting close that hole.
The CLI generators create files with the naming, wiring and spec files the project expects. Hand-made modules often forget to register themselves.
Scattered process.env reads are untyped and hard to test. ConfigService validates configuration at startup.
npx nest g resource <name>.ValidationPipe runs with whitelist: true.new.ConfigService, never process.env directly in feature code.Test.createTestingModule and mock providers; e2e tests run with npm run test:e2e.NotFoundException, ForbiddenException) instead of returning error objects.Want different commands or rules? Load this preset into the generator, change anything, and download your own set.
AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.
All presets are on the stacks page.
Neither specifically. Add one line to the notes in the generator naming your ORM and its migration commands so the agent uses them.
Schema changes affect every environment and are hard to roll back. The rule makes the agent propose the migration and wait, which is the safe default for shared databases.
Yes. The module, DTO and DI rules apply unchanged; add your transport, such as a message queue, to the stack notes.
Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.
You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.
F12, or Cmd+Option+I on a Mac, and select the Network tab.Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.