docs/agent-mux/reference
Agent Mux Reference guide
This directory is the canonical contract for current @a5c-ai/agent-mux behavior.
Pages in this section
Start with the section hub, then move sideways into adjacent pages when you need more detail.
The package family is split across several published packages in the babysitter
wiki/docs/agent-mux/reference/01-core-types-and-client.md
This specification defines the complete parameter surface for invoking agents through agent-mux: the RunOptions interface, supporting types (Attachment, RetryPolicy, McpServerConfig), the profile system for storing and resolving named option presets, and the validation, capability-gating, and resolution rules that govern how options flow from source to subprocess.
wiki/docs/agent-mux/reference/02-run-options-and-profiles.md
This specification defines the complete runtime interface for agent invocations: the RunHandle returned by mux.run(), the RunResult it resolves to, the InteractionChannel for building interactive UIs, the run state machine, subprocess lifecycle management, and all platform-specific behaviors.
wiki/docs/agent-mux/reference/03-run-handle-and-interaction.md
Last refreshed: 2026-04-25
wiki/docs/agent-mux/reference/04-agent-events.md
This specification defines the adapter system: the primary extension and abstraction layer that allows agent-mux to drive any CLI-based AI coding agent through a uniform interface. The adapter system consists of three core pieces:
wiki/docs/agent-mux/reference/05-adapter-system.md
This specification defines the capability discovery, model introspection, and thinking normalization systems in agent-mux. These three concerns are tightly related: capabilities determine what an agent can do, the model registry provides per-model granularity within those capabilities, and thinking normalization translates the unified thinkingEffort abstraction into each agent's native parameters.
wiki/docs/agent-mux/reference/06-capabilities-and-models.md
The SessionManager provides read-only access to agent session data stored in each agent's native format and location. agent-mux does not own, replicate, or migrate session data -- it reads on demand, normalizes into unified types, and exposes a consistent query surface across all ten supported agents.
wiki/docs/agent-mux/reference/07-session-manager.md
This specification defines two manager interfaces and their supporting types:
wiki/docs/agent-mux/reference/08-config-and-auth.md
This specification defines the PluginManager interface and the complete plugin ecosystem for agent-mux. The plugin system provides a unified interface for discovering, installing, updating, and removing plugins across all supported agents, despite each agent having a fundamentally different native plugin architecture.
wiki/docs/agent-mux/reference/09-plugin-manager.md
The amux binary is the CLI surface of the @a5c-ai/agent-mux project. It exposes every capability of the SDK -- running agents, inspecting adapters, managing sessions, configuring agents, handling authentication, working with plugins, and tracking costs -- through a single command-line interface.
wiki/docs/agent-mux/reference/10-cli-reference.md
This specification is the authoritative reference for subprocess management, process safety guarantees, and cross-platform support in @a5c-ai/agent-mux. It consolidates and deepens the process-lifecycle material introduced in 03-run-handle-and-interaction.md (sections 6–12), adds the full per-agent cross-platform compatibility matrix from scope §23, and specifies platform-specific path resolution, shell invocation, PTY backend selection, and resource cleanup in detail.
wiki/docs/agent-mux/reference/11-process-lifecycle-and-platform.md
This specification defines the implementation details for all 13 built-in adapter implementations in @a5c-ai/agent-mux. Each adapter extends BaseAgentAdapter (spec 05 §4) and translates between the unified AgentAdapter interface and the native CLI of its target agent.
wiki/docs/agent-mux/reference/12-built-in-adapters.md
Invocation Modes
PageAn invocation mode selects where a harness subprocess runs. The adapter contract is mode-agnostic: buildSpawnArgs() returns an abstract SpawnArgs { command, args, env, cwd, stdin?, shell? }, and a pure transform — buildInvocationCommand() — rewrites it into the concrete host command for the chosen mode.
wiki/docs/agent-mux/reference/13-invocation-modes.md
Harness Mock
PageCanonical package documentation lives in packages/agent-mux/harness-mock/README.md.
wiki/docs/agent-mux/reference/14-harness-mock.md
agent-mux provides a harness-agnostic hook system that lets one
wiki/docs/agent-mux/reference/15-hooks.md
Agent Mux Reference
This directory is the canonical contract for current @a5c-ai/agent-mux behavior.
Audience
- Package consumers who need the current API surface
- Maintainers reviewing a behavior change against the normative docs
- Integrators checking capability, session, and invocation rules
Recommended Reading Order
1. Core types and client 2. Run options and profiles 3. Run handle and interaction 4. Agent events 5. Adapter system 6. Capabilities and models 7. Session manager 8. Config and auth 9. Plugin manager 10. CLI reference 11. Process lifecycle and platform 12. Built-in adapters 13. Invocation modes 14. Harness mock 15. Hooks
Adapter-specific notes live under agents/ and should be treated as reference supplements, not separate product sections.