Report · marked 9 Oct 2026

diegosouzapw/OmniRoute

Solid foundations, held back in a few specific places.

TypeScript · 74,636 stars · 25,262 files · branch release/v3.8.52

82 /100 A-

Instructions 22/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality and readme as an entry point.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 24/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 8/20Whether the repo fits in a context window, or fights it. Losing marks on no committed build output and file sizes fit in context.Navigability 10/10How quickly anything new can orient itself. Full marks.

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

Fix these first

README as an entry point

Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.

Repository weight

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 22/27 A-

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, Copilot instructions

✗Instruction quality 10/12

Specific enough that an agent can act on it.

Worth fixing: it's 66k 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 0/3

No README. This is the first file anything reads, human or machine.

Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.

Setup 20/20 A+

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

✓Deterministic install 6/6

package-lock.json pins the dependency tree.

Found package-lock.json

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (dev, prebuild:docs, gen:provider-reference, gen:i18n-routes, bench:compression, bench:heap-body…)

Makefile

scripts/ directory

✓Environment config 4/4

.env.example documents what the app needs to run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found .nvmrc

✓Reproducible environment 2/2

dockerfile gives a known-good environment.

Verification loop 24/25 A+

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

✓Tests exist 8/8

7441 test files against 13046 source files.

e.g. @omniroute/opencode-plugin-v2/tests/api-package.test.ts, @omniroute/opencode-plugin-v2/tests/cache-ttl-snapshot.test.ts, @omniroute/opencode-plugin-v2/tests/catalog-provider.test.ts

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

28 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 8/20 C

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

✗No committed build output 3/6

Generated output is committed: coverage/.

Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.

✓.gitignore hygiene 3/3

.gitignore covers 173 patterns.

✗File sizes fit in context 2/6

11 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.

@omniroute/opencode-plugin/src/index.ts — 250KB

src/app/(dashboard)/dashboard/combos/page.tsx — 210KB

open-sse/handlers/chatCore.ts — 166KB

✗Repository weight 0/5

About 1472MB 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 diegosouzapw/OmniRoute

# AGENTS.md

Never stop coding. Free MIT AI gateway: one endpoint, 359 providers (150+ free), 1200+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by hundreds of contributors

## Setup

```
npm ci
```

## Commands

```
npm run dev # run locally
npm run start # run the app
npm run build # produce a build
npm run test # run the test suite, must pass before any commit
npm run lint # lint
npm run check # lint and type check
npm run prebuild:docs
npm run gen:provider-reference
```

## Layout

- `tests/` 7060 source files
- `src/` 3502 source files
- `open-sse/` 1822 source files
- `scripts/` 290 source files
- `bin/` 220 source files
- `@omniroute/` 101 source files

## Conventions

- Tests live alongside the code they cover, following `@omniroute/opencode-plugin-v2/tests/api-package.test.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/api-route-typecheck.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `@omniroute/opencode-plugin/src/index.ts` is 250KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/diegosouzapw/OmniRoute.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](https://agentreadme.com/badge/diegosouzapw/OmniRoute.svg)](https://agentreadme.com/diegosouzapw/OmniRoute)

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