agentreadme

Report · marked 26 Aug 2026

twentyhq/twenty

An agent will struggle here, mostly for fixable reasons.

TypeScript · 55,537 stars · 28,952 files · branch main

Fix these first

01
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
02
Instruction quality
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
03
File sizes fit in context
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

The full marking

Every deduction below names the file or setting it came from.

Instructions 15/27 B-

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
Instruction quality 0/12
Present but too thin to change an agent's behavior.
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
README as an entry point 3/3
README has a clear getting-started section.
Setup 14/20 B+

Whether an agent can install the project and get it running without a human.

Deterministic install 6/6
yarn.lock pins the dependency tree.
Found yarn.lock
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (docs:generate, docs:generate-navigation-template, docs:generate-paths, docs:prune-orphans, start)
Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
Pinned runtime version 2/2
The language runtime version is pinned.
Found .nvmrc
Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 12/25 C+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 8/8
4333 test files against 23983 source files.
e.g. .github/workflows/ci-utils-test.yaml, packages/create-twenty-app/src/constants/template/src/__tests__/application-config.test.ts, packages/create-twenty-app/src/constants/template/src/__tests__/global-setup.ts
Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
Continuous integration 4/4
46 GitHub Actions workflows define what "passing" means.
Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 9/20 C

Whether the repo fits in a context window, or fights it.

No committed build output 6/6
No generated directories committed.
.gitignore hygiene 3/3
.gitignore covers 59 patterns.
File sizes fit in context 0/6
98 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
packages/twenty-server/src/engine/core-modules/application/application-package/constants/yarn-engine/.yarn/releases/yarn-4.9.2.cjs — 2935KB
.yarn/releases/yarn-4.13.0.cjs — 2934KB
packages/twenty-front/src/generated-metadata/graphql.ts — 1361KB
Repository weight 0/5
About 1744MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for twentyhq/twenty
# 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.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/twentyhq/twenty.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 54 out of 100

[![agent ready](https://agentreadme.com/badge/twentyhq/twenty.svg)](https://agentreadme.com/twentyhq/twenty)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

All TypeScript repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in