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
- Core types and client
- Run options and profiles
- Run handle and interaction
- Agent events
- Adapter system
- Capabilities and models
- Session manager
- Config and auth
- Plugin manager
- CLI reference
- Process lifecycle and platform
- Built-in adapters
- Invocation modes
- Harness mock
- Hooks
Adapter-specific notes live under agents/ and should be treated as reference supplements, not separate product sections.