beads/docs/integrations/mux.md
Chris Sells a86a2c5dfc docs: port user docs into the Mintlify site tree under docs/
Port the website's current (non-versioned) authored pages into docs/ as
Mintlify pages: frontmatter title as H1 (body H1s removed), Docusaurus
admonitions converted to Mintlify components, root-relative extensionless
links, mermaid fences kept as-is. website/docs/** is untouched and keeps
serving the Docusaurus site until cutover.

git-mv the user-facing docs/ originals with no website twin into the new
IA (core-concepts/, architecture/, workflows/, recovery/, multi-agent/,
integrations/, reference/), converted to Mintlify form. The six files
previously mirrored by sync-website-docs.sh now live once in the site.
ERROR_HANDLING.md and CONTRIBUTOR_NAMESPACE_ISOLATION.md move to engdocs/
(contributor pattern guide and design doc per content review).

Pointer stubs remain at docs/{DOLT,STORAGE-BACKENDS,PLUGIN,RECOVERY,
JSON_SCHEMA}.md because released bd binaries print those paths; QUICKSTART
and DOLT-BACKEND stay as existing pointer stubs.

Corrected while porting: the intro's storage diagram claimed data lives at
.beads/dolt/; embedded mode (the default) uses .beads/embeddeddolt/
(internal/storage/embeddeddolt/store.go), server mode uses .beads/dolt/.
2026-07-12 10:37:07 -07:00

699 B

title
Mux

Use Beads with Mux through AGENTS.md, optional layered Mux instruction files, and Mux hooks.

bd setup mux
bd setup mux --check

The default setup writes a managed Beads section to root AGENTS.md.

Workspace and Global Layers

Mux also supports workspace and global instruction layers:

bd setup mux --project
bd setup mux --global
bd setup mux --project --global

Project setup writes .mux/AGENTS.md and installs Mux hook files under .mux/:

  • .mux/init
  • .mux/tool_post
  • .mux/tool_env

Global setup writes ~/.mux/AGENTS.md.

Remove

bd setup mux --remove
bd setup mux --project --remove
bd setup mux --global --remove