agentreadme

Report · marked 25 Aug 2026

AstrBotDevs/AstrBot

Ready for an agent to work in without hand-holding.

Python · 39,601 stars · 1,636 files · branch master

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
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

The full marking

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

Instructions 27/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: Copilot instructions
Instruction quality 12/12
Specific enough that an agent can act on it.
6,501 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 3/3
README has a clear getting-started section.
Setup 13/20 B

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

Deterministic install 3/6
Only requirements.txt, which pins loosely at best.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
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 2/2
The language runtime version is pinned.
Found .python-version
Reproducible environment 2/2
dockerfile 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
195 test files against 939 source files.
e.g. .github/workflows/coverage_test.yml, .github/workflows/smoke_test.yml, dashboard/tests/extensionPreferenceStorage.test.mjs
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 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 45 patterns.
File sizes fit in context 0/6
5 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.
astrbot/core/utils/t2i/template/shiki_runtime.iife.js — 1238KB
astrbot/core/config/default.py — 221KB
dashboard/src/api/generated/openapi-v1/sdk.gen.ts — 136KB
Repository weight 4/5
About 70.7MB 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 AstrBotDevs/AstrBot
# AGENTS.md

AI Agent Assistant & development framework that integrates lots of IM platforms, LLMs, plugins and AI feature, and can be your openclaw alternative. ✨

## Setup

```
pip install -r requirements.txt
```

## Commands

```
make worktree
make worktree-add
make worktree-rm
make pr-test-neo
make pr-test-full
make pr-test-full-fast
```

## Layout

- `astrbot/`   497 source files
- `dashboard/` 254 source files
- `tests/`     166 source files
- `docs/`      14 source files
- `scripts/`   6 source files

## Conventions

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

## Gotchas

- `astrbot/core/utils/t2i/template/shiki_runtime.iife.js` is 1238KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/AstrBotDevs/AstrBot.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 85 out of 100

[![agent ready](https://agentreadme.com/badge/AstrBotDevs/AstrBot.svg)](https://agentreadme.com/AstrBotDevs/AstrBot)

Other Python repositories, marked

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

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