AGENTS.md

1# AGENTS.md
2 
3## Cursor Cloud specific instructions
4 
5`pnpm setup:agent` has already been run. Do not run it again. The environment is fully configured: dependencies installed, enterprise packages linked, project built, `.env` files in place, Docker services running, and a default user/org seeded. The dashboard auto signs in the pre-seeded agent user when opened in the browser (no manual login unless auto sign-in fails).
6 
7## Build
8 
9Run `pnpm build` after changes to `packages/` or `enterprise/`. Direct changes to `apps/` do not require a rebuild.
10 
11## AI Boundaries
12 
13### Always
14- Work within: `apps/api`, `apps/dashboard`, `apps/worker`, `apps/ws`
15- Use shared packages: `packages/shared`, `packages/framework`, `packages/js`, `packages/react`
16- Follow `libs/dal` for data access, `libs/application-generic` for business logic
17 
18### Ask First
19- Before creating new UI components not in `apps/dashboard/src/components/`
20- Before adding npm dependencies
21- Before modifying MongoDB models, ClickHouse table definitions, or anything in `enterprise/` or `packages/providers/`
22 
23### Never
24- Inactive apps — do not touch, unless monorepo wide refactor: `apps/webhook`
25- Auto-generated — never edit: `libs/internal-sdk`
26- UI: reuse existing Radix/shadcn components only; do not copy patterns from `playground/` into production code
27- If doing a monorepo wide refactor, you can touch the read only, but only when necessary.
28 
29 
30## Developer-local agent config
31 
32If a **`.agents-local/`** directory exists in your working copy, read **`.agents-local/README.md`** first for personal, git-ignored agent configuration, skills and rules. Absence of the directory is normal.
33 
34## Novu Distribution
35Novu is distributed in 3 modes, Community Edition, Enterprise Cloud Edition, and On-Prem Enterprise Edition.
36 
37When making changes targeted to the Enterprise distribution, we need to make sure that the changes are not breaking the Community edition, and are properly gated behind a flag, or the novu enterpise env variables. Similarly when some changes are only targeting the Cloud, self-hosted on prem should not be affected.
38 
39<!-- Infrastructure & services: see .cursor/rules/infrastructure.mdc -->
40<!-- Dependency graph: see .cursor/rules/dependency-graph.mdc -->
41<!-- Testing: see .cursor/rules/testing.mdc -->
42<!-- PR format: see .cursor/rules/pullrequest.mdc -->
43<!-- Enterprise submodule: see .cursor/skills/enterprise-submodule/SKILL.md -->
44