848515e5d4
Replace the two thin "docs live in …" lines with the conventions the docs/ READMEs establish: the three document types (PRD / research note / decision record) with their numbering and the PRD Status lifecycle, plus the cross-cutting rule that decision rationale stays self-contained in the repo rather than in Gitea issue threads. Points at the per-folder READMEs as the source of truth instead of duplicating them. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2.9 KiB
2.9 KiB
bot-bottle
What this is
bot-bottle spins up an isolated container for running AI coding agents with a
curated set of skills and env vars. The point is to run agents with broad
permissions inside a sandbox, so a misbehaving agent cannot reach the host.
A Python CLI (entry point cli.py, package bot_bottle/) orchestrates
the container lifecycle and the copying of skills and env vars into it.
Goals
- Minimize risk of running agents with full permissions
- Allow me to easily spin up agent tasks in parallel
- Create isolated, well defined, easily updated, shareable agents
Non-goals
- Communicating between agents directly
- Self hosted VMs (v1 uses local Docker containers, not VMs)
- Advanced agent auditing (lean on git history for auditing)
Repository layout
README.md— short public-facing description.AGENTS.md— this file, orientation for future agent sessions..gitignore— OS junk.bot-bottle.json— legacy manifest of named agents (env / skills / prompt per agent), consumed bycli.py. See "Manifest" under "Intended design".docs/README.md— docs overview; when to write which document.docs/prds/— product requirement docs (seedocs/prds/README.mdfor format).docs/research/— research notes (seedocs/research/README.md).docs/decisions/— decision records (ADR-lite).
Conventions
- Three kinds of doc, each with its own conventions in-folder; see
docs/README.mdfor when to write which:- PRDs (
docs/prds/) — one feature per file, numberedNNNN-kebab.md. AStatus:line tracks lifecycle: Draft → Active (shipped tomain) → Superseded/Retargeted. Format indocs/prds/README.md. - Research notes (
docs/research/) — opinionated investigations; unnumbered kebab-case, freeform and verdict-first. Seedocs/research/README.md. - Decision records (
docs/decisions/) — ADR-lite, numberedNNNN-kebab.md, for policies and non-feature decisions. Seedocs/decisions/README.md.
- PRDs (
- Keep decision rationale self-contained in the repo, not in Gitea issue threads. Issues are an ephemeral inbox; the durable "why" lives in a PRD, research note, or decision record.
- Low dependencies by default. The project is Python, stdlib-first (no runtime pip dependencies in the package itself; the only language runtime is the Python 3.13 used by the CLI + sidecars). Ask before adding new tools, runtimes, or package managers.
- Commit messages follow Conventional Commits:
<type>[(scope)][!]: <description>, where<type>is one offeat,fix,docs,style,refactor,perf,test,build,ci,chore,revert. Acommit-msghook in.githooks/enforces this. Activate it once per clone withgit config core.hooksPath .githooks.
When you're unsure
Ask. Default to drafting in chat over editing files when the request is ambiguous.