Report · marked 10 Oct 2026

janhq/jan

An agent can work here, but it will waste turns finding its footing.

Rust · 44,877 stars · 2,735 files · branch main

57 /100 B-

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 18/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.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 7/10How quickly anything new can orient itself. Losing marks on license.

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

Fix these first

Agent instruction file

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

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 3/27 F

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

✗Agent instruction file 0/12

None found. Every agent that opens this repo starts from zero.

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules

✗Instruction quality 0/12

Nothing to judge, since there are no instructions.

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 18/20 A

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 (lint, dev, ios, android, build, test…)

Makefile

scripts/ directory

✗Environment config 2/4

Env vars are mentioned in the README but there's no example file to copy.

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 rust-toolchain.toml

✓Reproducible environment 2/2

.devcontainer/devcontainer.json gives a known-good environment.

Verification loop 19/22 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

462 test files against 1438 source files.

e.g. .github/workflows/jan-linter-and-test.yml, adk/python/tests/__init__.py, adk/python/tests/harness.py

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

41 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 n/a

Not applicable — the Rust compiler type checks every build.

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 62 patterns.

✗File sizes fit in context 0/6

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

src-tauri/src/core/cli/tui.rs — 1879KB

src-tauri/static/swagger-ui/swagger-ui-bundle.js — 1472KB

src-tauri/src/core/agent/loop.rs — 479KB

✗Repository weight 0/5

About 1576MB 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 janhq/jan

# AGENTS.md

Jan is an open source alternative to ChatGPT that runs 100% offline on your computer.

## Setup

```
yarn install
```

## Commands

```
yarn dev         # run locally
yarn build       # produce a build
yarn test        # run the test suite, must pass before any commit
yarn lint        # lint
yarn ios
yarn android
yarn test:core
yarn test:web
```

## Layout

- `web-app/`    844 source files
- `src-tauri/`  281 source files
- `core/`       101 source files
- `docs/`       69 source files
- `extensions/` 59 source files
- `autoqa/`     16 source files

## Conventions

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

## Gotchas

- `src-tauri/src/core/cli/tui.rs` is 1879KB. 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/janhq/jan.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Rust 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/janhq/jan.svg)](https://agentreadme.com/janhq/jan)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ clash-verge-rev/clash-verge-rev 91 A farion1231/cc-switch 63 B openai/codex 61 B- rustdesk/rustdesk 72 B+ rust-lang/rust 65 B

All Rust 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