Skip to content
docsmuxd init

command · project

muxd init

Index docs for this project's dependencies and connect its AI agents.

usage
muxd init [--skip-instructions] [--skip-client-config]

Run it once at the root of a project. muxd reads the manifests it finds (package.json, Cargo.toml, pyproject.toml, requirements.txt, go.mod, including npm and Cargo workspaces), resolves documentation for every direct dependency and indexes it locally.

For each dependency it looks for an llms.txt published on the package's homepage or docs site first, uses docs.rs for Rust crates, and falls back to the README pinned to the installed version. Dependencies with no usable docs are recorded and not retried until their version changes.

It then writes muxd.json, registers the muxd MCP server in the project's client configs (.mcp.json, .cursor/mcp.json, .vscode/mcp.json) and adds a short block to AGENTS.md / CLAUDE.md telling agents to call search_docs before using a library.

Options

--skip-instructionsDon't add the muxd block to AGENTS.md / CLAUDE.md.
--skip-client-configDon't write .mcp.json, .cursor/mcp.json or .vscode/mcp.json.

Examples

$ cd my-app && muxd init
$ muxd init --skip-instructions

Keep your agent instructions untouched.

Notes

  • Commit muxd.json and the files init wrote: teammates get the same docs and the same agent setup.
  • You rarely need to run it again. When an agent starts muxd mcp, it syncs in the background after dependency changes.

See also

muxd syncmuxd mcpmuxd install-client