Docs menu

Documentation

Docs

Guides for getting JoyMux running, wiring agents, and keeping the machine calm under load.

Start

  • Five-minute quick start

    Goal: install JoyMux, start the daemon, run a command, view events, interrupt, and close — in about five minutes.

  • Install JoyMux

    scripts/release/build.sh once — produces dist/ + formula

  • First run

    joymux init

Concepts

  • Architecture

    JoyMux is a local execution runtime. Its canonical record is an append-only,

  • Session lifecycle

    creating → ready → attached / detached → running → closed

  • Checkpoints and resume

    JoyMux checkpoints bind integrity over session, client, lane, correlation, terminal state, and event cursor (joymux.checkpoint.integrity.v1).

  • Embedded intent

    JoyMux ships a self-contained local understanding layer. A normal install must

Integrate

  • SDK

    Install and use the JoyMux SDKs for Rust, Python, and TypeScript. Packages ship from the JoyMux GitHub repo; npm and PyPI names are reserved but not yet published.

  • Client SDK

    Language SDKs for Rust, Python, and TypeScript covering connect, session, execute, events, and health.

  • Integrating an AI harness

    JoyMux does not choose or run the AI harness.

  • MCP integration

    joymux serve --mcp

  • HTTP API

    Default bind: 127.0.0.1:8790

Operate

  • Daemon service

    joymux daemon install

  • Operations

    JoyMux is a local Unix daemon. Run it under a service manager that restarts it on

  • Troubleshooting

    invalidrequest means the frame is malformed, non-UTF-8, truncated, over 1 MiB,

  • Security

    The MVP is local-only. The daemon creates its Unix socket with mode 0600 and has

Reference

  • Protocol v1

    Opaque IDs: ClientId, SessionId, ExecutionId, LaneId, CheckpointId, EventCursor, CorrelationId.

  • Error model

    Stable envelope (JoyMuxErrorEnvelope):

  • Authorization

    Single path for all transports: