agentreadme

Report · marked 10 Oct 2026

Dokploy/dokploy

Solid foundations, held back in a few specific places.

TypeScript · 37,740 stars · 1,572 files · branch canary

75 /100 B+
Instructions 18/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 20/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and static type checking.Context economy 18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability 5/10How quickly anything new can orient itself. Losing marks on written documentation and license.

Higher is better. Accent marks what is costing you most.

Fix these first

01
Environment config
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.
02
Instruction quality
Worth fixing: it never states a build, test, or run command; has no code blocks.
03
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.

The full marking

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

Instructions 18/27 B

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

✗Agent instruction file 9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
✗Instruction quality 6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
326 characters, a workable length
uses headings, so an agent can skim it
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 16/20 A-

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

✓Deterministic install 6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (dokploy:setup, dokploy:dev, dokploy:build, dokploy:start, test, server:script…)
scripts/ directory
✗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 2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 20/25 A-

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

✗Tests exist 6/8
121 test files against 1237 source files.
e.g. .github/workflows/upgrade-integration-test.yml, apps/dokploy/__test__/api/api-key-name.test.ts, apps/dokploy/__test__/api/session-management.test.ts
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
10 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
biome.json encodes the house style.
✗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 18/20 A

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 25 patterns.
✗File sizes fit in context 4/6
1 source file is 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.
apps/dokploy/lib/bundled-icons.ts — 121KB
✓Repository weight 5/5
About 34.4MB checked out, which is comfortable.

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 Dokploy/dokploy 
# AGENTS.md

Open Source Alternative to Vercel, Netlify and Heroku.

## Setup

```
pnpm install
```

## Commands

```
pnpm build           # produce a build
pnpm test            # run the test suite, must pass before any commit
pnpm typecheck       # type check without emitting
pnpm check           # lint and type check
pnpm dokploy:setup
pnpm dokploy:dev
pnpm dokploy:build
pnpm dokploy:start
```

## Layout

- `apps/`     952 source files
- `packages/` 281 source files
- `scripts/`  4 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/upgrade-integration-test.yml`.
- CI defines what passing means. See `.github/workflows/create-pr.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `apps/dokploy/lib/bundled-icons.ts` is 121KB. 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/Dokploy/dokploy.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

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 75 out of 100

[![agent ready](https://agentreadme.com/badge/Dokploy/dokploy.svg)](https://agentreadme.com/Dokploy/dokploy)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 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