Report · marked 25 Aug 2026
khoj-ai/khoj
An agent can work here, but it will waste turns finding its footing.
Python · 36,719 stars · 702 files · branch master
66
/100
B
Instructions
2/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
14/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.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
17/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
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.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
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 2/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
2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 14/20 B+
Whether an agent can install the project and get it running without a human.
✓Deterministic install
6/6
uv.lock pins the dependency tree.
Found uv.lock
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
pyproject.toml scripts
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
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✓Reproducible environment
2/2
.devcontainer/devcontainer.json 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
63 test files against 262 source files.
e.g. src/interface/emacs/tests/khoj-tests.el, tests/__init__.py, tests/conftest.py
✓Test command is discoverable
7/7
An agent can find and run `pytest`.
✓Continuous integration
4/4
11 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
pyproject.toml encodes the house style.
✗Static type checking
2/3
Type checking is configured, but not in strict mode.
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 17/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 39 patterns.
✗File sizes fit in context
4/6
2 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/khoj/routers/helpers.py — 129KB
src/interface/obsidian/src/chat_view.ts — 113KB
✗Repository weight
4/5
About 117.3MB 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 Your AI second brain. Self-hostable. Get answers from the web or your docs. Build custom agents, schedule automations, do deep research. Turn any online or local LLM into your personal, autonomous AI (gpt, claude, gemini, llama, qwen, mistral). Get started - free. ## Setup ``` uv sync ``` ## Commands ``` pytest # run the test suite ruff check . # lint ``` ## Layout - `src/` 227 source files - `tests/` 28 source files - `documentation/` 4 source files - `scripts/` 2 source files ## Conventions - Tests live alongside the code they cover, following `src/interface/emacs/tests/khoj-tests.el`. - CI defines what passing means. See `.github/workflows/build_khoj_el.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `src/khoj/routers/helpers.py` is 129KB. 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/khoj-ai/khoj.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/khoj-ai/khoj)Other Python 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.