Use BeeUI with coding agents
BeeUI publishes a small family of generated text files for coding-agent context. They are model-agnostic and generated from the same public package, Registry, compatibility, component and pattern authorities used by human docs.
Prerequisites: none — these are plain-text files an agent (or you) can fetch directly; no BeeUI installation is required to read them.
Pick the smallest useful context
Section titled “Pick the smallest useful context”| Task | Context |
|---|---|
| Understand BeeUI, setup and key invariants | /llms.txt |
| Bootstrap or troubleshoot a complete supported consumer | /llms-full.txt |
| Select/use components and inspect platform/a11y contracts | /llms-components.txt |
| Compose production-oriented screens from accepted patterns | /llms-patterns.txt |
/llms-components.txt lists each component’s exported symbols and source path only. The full Props table (prop, type, default, description) for a component lives at /docs/components/<name>/ — for example /docs/components/list-item/ — and is not repeated in the txt file; follow the component name through to its docs page before guessing a prop’s shape from the source.
Start small and add the larger file only when the task needs it. The files are public static assets; the Worker must serve them as plain text without rewriting them to HTML.
Rules an agent must preserve
Section titled “Rules an agent must preserve”- BeeUI is UI infrastructure; routing, data fetching, backend, auth, payments and business rules remain application-owned.
- See the release status above for the current publication truth. During the
0.86.2prerelease linelatestfollows the newest complete, verified RC only after the owner moves it for all four packages, so it can lagnext; the last observedlatesttarget is recorded indocs/dist-tag-policy.md, and stable0.86.2moves it at stable promotion. Always suffix a registry command with@next(or the exact RC version) — do not recommend an unqualified, untagged install, sincelatestlagsnextbetween an RC publication and the owner’s move. See Start anddocs/dist-tag-policy.md. - Prefer public exports and semantic tokens; do not import private workspace internals.
- Mobile-first responsive behavior, keyboard/focus, RTL, large text and reduced motion are correctness constraints, not optional polish.
- Web preview evidence is Web evidence. Native compile/bundle evidence is not native interaction proof.
- For source ownership, use Registry dependency closure and review
diff/updateplans rather than hand-copying arbitrary internals.
Verification after generation
Section titled “Verification after generation”After an agent changes BeeUI consumer code, run the consumer’s typecheck/build/tests and exercise the relevant runtime path. Inside this repository, the canonical regression surfaces include pnpm llms:check, pnpm ai-contract:check, Registry verification, docs/example checks, and the platform-specific Showcase/consumer gates appropriate to the change.
When setup fails, diagnose the actual boundary first: package/publication state, provider/safe area, Web theme/source scanning, native peer/rebuild, overlay scope, or Registry dependency compatibility. Do not work around failures by reaching into private imports.