Docs menu

Integrate

Integrating an AI harness

JoyMux does not choose or run the AI harness.
The AI harness connects to JoyMux and delegates terminal execution.
The harness owns reasoning. JoyMux owns execution.

Steps

  1. Install JoyMux once (cargo install --path crates/joymux-cli or package).
  2. Run joymux doctor --json and read endpoints.
  3. Register as a client (client/register / MCP initialize).
  4. Create or attach a session.
  5. Call execution/start with program + args.
  6. Consume structured events by cursor.
  7. Interrupt/terminate/checkpoint as needed.

Transports

Transport Command / endpoint Status
CLI joymux exec --jsonl -- … implemented
JSON-RPC stdio joymux serve --stdio implemented
MCP joymux serve --mcp implemented
Unix socket ~/.joymux/joymux.sock (legacy daemon API) partially implemented
HTTP/SSE http://127.0.0.1:8790 designed only

See also: mcp-integration.md, jsonrpc-integration.md, client-integration.md.