agentreadme

Report · marked 10 Oct 2026

jamiepine/voicebox

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

Python · 56,781 stars · 633 files · branch main

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 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 14/20 B+

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

✓Deterministic install 6/6
bun.lock pins the dependency tree.
Found bun.lock
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (dev, dev:web, dev:server, setup:dev, build, build:web…)
justfile
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
dockerfile gives a known-good environment.
Verification loop 20/25 A-

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

✗Tests exist 6/8
54 test files against 392 source files.
e.g. backend/tests/E2E_MODEL_TEST_DESIGN.md, backend/tests/README.md, backend/tests/__init__.py
✓Test command is discoverable 7/7
An agent can find and run `npm run check`.
✓Continuous integration 4/4
2 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
biome.json encodes the house style.
✗Static type checking 0/3
No static type checking.
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 19/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 52 patterns.
✓File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
✗Repository weight 4/5
About 102.5MB 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 — drafted for jamiepine/voicebox
# AGENTS.md

The open-source AI voice studio. Clone, dictate, create.

## Setup

```
bun install
```

## Commands

```
bun dev          # run locally
bun build        # produce a build
bun typecheck    # type check without emitting
bun lint         # lint
bun format       # format
bun check        # lint and type check
bun dev:web
bun dev:server
```

## Layout

- `app/`     179 source files
- `backend/` 147 source files
- `tauri/`   26 source files
- `docs/`    21 source files
- `scripts/` 11 source files
- `web/`     8 source files

## Conventions

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

---

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/jamiepine/voicebox.md

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

[![agent ready](https://agentreadme.com/badge/jamiepine/voicebox.svg)](https://agentreadme.com/jamiepine/voicebox)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 89 A yt-dlp/yt-dlp 54 C+ microsoft/markitdown 48 C+ Significant-Gravitas/AutoGPT 65 B

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