# 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.