agentreadme

Report · marked 10 Oct 2026

The-Vibe-Company/quivr

Solid foundations, held back in a few specific places.

Go · 39,578 stars · 2,566 files · branch main

Fix these first

01
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.
02
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.
03
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

The full marking

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

Instructions 25/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.
✗Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
7,610 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 14/20 B+

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

✓Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
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.
go.mod declares a Go version
✗Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
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
616 test files against 1384 source files.
e.g. .agents/skills/plan-pr/evals/fixtures/project/src/export.test.js, .agents/skills/review-code-dev/scripts/test_ocr.py, .agents/skills/ship-pr-dev/scripts/test_collect_ship_context.py
✓Test command is discoverable 7/7
An agent can find and run `make test`.
✓Continuous integration 4/4
12 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 Go compiler type checks every build.
Context economy 11/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 14 patterns.
✗File sizes fit in context 0/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.
client/client.gen.go — 1117KB
internal/transport/generated/transport.gen.go — 520KB
✗Repository weight 2/5
About 175MB 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 The-Vibe-Company/quivr
# AGENTS.md

An open-source engine that turns continuous content streams into search and monitoring. Durable ingestion, hybrid search, alerts, and plugins for formats, models and business rules.

## Setup

```
go mod download
```

## Commands

```
make env
make demo
make demo-reset
make verify-demo
make demo-perf
make check         # lint and type check
```

## Layout

- `internal/`     675 source files
- `scripts/`      182 source files
- `quivr-search/` 137 source files
- `plugins/`      95 source files
- `migrations/`   88 source files
- `tests/`        75 source files

## Conventions

- Tests live alongside the code they cover, following `.agents/skills/plan-pr/evals/fixtures/project/src/export.test.js`.
- CI defines what passing means. See `.github/workflows/docs-site.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `client/client.gen.go` is 1117KB. 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/The-Vibe-Company/quivr.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Go 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 80 out of 100

[![agent ready](https://agentreadme.com/badge/The-Vibe-Company/quivr.svg)](https://agentreadme.com/The-Vibe-Company/quivr)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- JuliusBrussee/caveman 81 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