# AGENTS.md

Ultra-lightweight, open-source, self-hosted personal AI agent framework in Python with WebUI, tools, memory, MCP, multi-agent workflows, automation, and chat apps

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

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

## Layout

- `nanobot/` 401 source files
- `tests/`   313 source files
- `webui/`   248 source files
- `tui/`     45 source files
- `scripts/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `nanobot/channels/dingtalk/tests/__init__.py`.
- 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.

## Gotchas

- `nanobot/channels/websocket/tests/test_websocket_channel.py` is 201KB. 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.