# AGENTS.md

The open alternative to Salesforce, designed for AI.

## Setup

```
yarn install
```

## Commands

```
yarn start                               # run the app
yarn docs:generate
yarn docs:generate-navigation-template
yarn docs:generate-paths
yarn docs:prune-orphans
```

## Layout

- `packages/` 23980 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/ci-utils-test.yaml`.
- CI defines what passing means. See `.github/workflows/app-prod-parity-e2e-dispatch.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/twenty-server/src/engine/core-modules/application/application-package/constants/yarn-engine/.yarn/releases/yarn-4.9.2.cjs` is 2935KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.