Docs menu

Documentation

Docs

Guides for getting JoyMux running, wiring harnesses, and keeping execution state when a terminal dies. Public docs describe observable behavior, CLI/SDK usage, security guarantees, and limitations — not how JoyMux is built. Start here: install· download macOS archives. Prefer the contract first? What JoyMux guarantees.

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

    Download a macOS archive from joymux.com, put joymux on PATH, save the trial lease.

  • First run

    Save the lease, joymux init, doctor, license status.

  • Uninstall

    Stop the daemon, remove the user service, optionally delete ~/.joymux.

Concepts

  • What JoyMux guarantees

    The public contract: durable execution state, recoverable evidence, bounded context, and how you verify it — not an implementation blueprint.

  • Session lifecycle

    Detach does not kill the work. Attach reconnects you. Close ends the session. Observable session semantics for operators and integrators.

  • Checkpoints and resume

    Resume from durable execution state. Replay is always available; live terminal reattach after restart is not always claimed.

  • Embedded intent

    JoyMux understands ordinary language locally. A normal install must not require Ollama or an external model server.

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 — the same session, execution, event, and checkpoint contract as the CLI and SDK.

  • HTTP API

    Loopback HTTP for local integration. Default bind 127.0.0.1:8790. Bearer token required. Not a public remote-control plane.

Operate

  • Daemon service

    joymux daemon install

  • Operations

    Run the local daemon under a user service, set data-dir and memory bounds, back up ~/.joymux, and monitor failure behavior.

  • Troubleshooting

    What public errors mean, the limits you will hit, and how to recover without reconstructing the task.

  • Security

    Local-first guarantees: what runs on your machine, what data leaves, required permissions, uninstall, and honest limitations.

Reference

  • Protocol v1

    Operations a third-party client uses to integrate with JoyMux: sessions, execution, events, checkpoints. Not an internals map.

  • Error model

    Stable envelope (JoyMuxErrorEnvelope):

  • Authorization

    Who can see, attach, write, interrupt, or close a session. Permissions an integrator needs — not the internal decision engine.