Report · marked 25 Aug 2026
TriliumNext/Trilium
Solid foundations, held back in a few specific places.
TypeScript · 37,589 stars · 5,717 files · branch main
73
/100
B+
Instructions
22/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
17/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on test command is discoverable and static type checking.Context economy
9/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
10/10How quickly anything new can orient itself. Full marks.
Higher is better. Accent marks what is costing you most.
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
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.
03
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.
The full marking
Every deduction below names the file or setting it came from.
Instructions 22/27 A-
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
10/12
Specific enough that an agent can act on it.
Worth fixing: it's 28k characters, which burns context on every single turn.
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
✓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 (client:test, client:build, client:coverage, client:stylelint, server:test, server:build…)
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
docker-compose.yml gives a known-good environment.
Verification loop 17/25 B
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
1122 test files against 2707 source files.
e.g. apps/client/src/components/entrypoints.spec.ts, apps/client/src/components/note_context.spec.ts, apps/client/src/components/startup_checks.spec.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
18 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
eslint.config.mjs encodes the house style.
✗Static type checking
2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
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 44 patterns.
✗File sizes fit in context
0/6
5 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/pdfjs-viewer/viewer/viewer.mjs — 803KB
packages/pdfjs-viewer/viewer/wasm/openjpeg_nowasm_fallback.js — 441KB
packages/splitjs/test/lib/jasmine-3.5.0/jasmine.js — 227KB
✗Repository weight
0/5
About 653MB 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 Build your personal knowledge base with Trilium Notes ## Setup ``` pnpm install ``` ## Commands ``` pnpm typecheck # type check without emitting pnpm client:test pnpm client:build pnpm client:coverage pnpm client:stylelint pnpm server:test pnpm server:build pnpm server:coverage ``` ## Layout - `apps/` 1661 source files - `packages/` 999 source files - `scripts/` 24 source files - `docs/` 5 source files ## Conventions - Tests live alongside the code they cover, following `apps/client/src/components/entrypoints.spec.ts`. - TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run. - CI defines what passing means. See `.github/workflows/checks.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `packages/pdfjs-viewer/viewer/viewer.mjs` is 803KB. 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/TriliumNext/Trilium.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/TriliumNext/Trilium)Other TypeScript repositories, marked
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.