agentreadme

Report · marked 26 Aug 2026

infiniflow/ragflow

Solid foundations, held back in a few specific places.

Go · 89,242 stars · 5,793 files · branch main

Fix these first

01
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
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
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.

The full marking

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

Instructions 26/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 12/12
Specific enough that an agent can act on it.
8,675 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
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 12/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 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
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.
go.mod declares a Go version
Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 22/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
1549 test files against 4814 source files.
e.g. agent/sandbox/sandbox_spec.md, agent/sandbox/tests/MIGRATION_GUIDE.md, agent/sandbox/tests/QUICKSTART.md
Test command is discoverable 7/7
An agent can find and run `pytest`.
Continuous integration 4/4
4 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
pyproject.toml encodes the house style.
Static type checking n/a
Not applicable — the Go compiler type checks every build.
Context economy 13/20 B

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 135 patterns.
File sizes fit in context 2/6
28 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.
web/public/iconfont.js — 222KB
web/src/locales/ja.ts — 205KB
rag/advanced_rag/knowlege_compile/wiki_incremental.py — 201KB
Repository weight 2/5
About 158MB 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 infiniflow/ragflow
# AGENTS.md

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fuses cutting-edge RAG with Agent capabilities to create a superior context layer for LLMs

## Setup

```
uv sync
```

## Commands

```
pytest          # run the test suite
ruff check .    # lint
go test ./...   # run the test suite
```

## Layout

- `internal/` 2173 source files
- `web/`      1396 source files
- `test/`     530 source files
- `rag/`      201 source files
- `api/`      143 source files
- `common/`   108 source files

## Conventions

- Tests live alongside the code they cover, following `agent/sandbox/sandbox_spec.md`.
- CI defines what passing means. See `.github/workflows/release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `web/public/iconfont.js` is 222KB. 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/infiniflow/ragflow.md

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

[![agent ready](https://agentreadme.com/badge/infiniflow/ragflow.svg)](https://agentreadme.com/infiniflow/ragflow)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 85 A golang/go 31 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 82 A- fatedier/frp 96 A+

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