Docs menu

Start

First run

Install the CLI first: install JoyMux. Default binary path is ~/.local/bin/joymux.

Lease

The trial (or paid term) is a signed file on your machine:

~/.joymux/entitlement_lease.json

Download it from the checkout success page after /get/. JoyMux evaluates it locally. No remote agent control.

Init

joymux init

Creates the data directory, writes local integration files so clients can find the daemon, optionally starts the daemon, and prints next steps.

Non-interactive:

joymux init --no-start-daemon --json

Check

joymux doctor --json
joymux license status

doctor should show the local socket and readiness. license status should show the trial or Pro term from the lease file.

Run your first session

joymux exec -- echo hello

A successful run prints hello. At that point JoyMux is installed, licensed, and executing a real session.

If license status shows no lease, the file is missing or the trial was not completed. Start again at /get/.