MaxyDocs
View as markdown →

Installing Maxy Code

Maxy Code installs from one npm one-liner on every supported host. The host you choose determines the supervisor (systemd vs launchd), the Cloudflare flow (provisioned vs operator-opt-in), and the VNC requirement (Pi/cloud VM only).

HostDocSupervisorCloudflare tunnelHostname flag
Raspberry Pi 5 (16GB) on Ubuntu Server 24.04pi.mdsystemd user-serviceprovisioned post-install via cloudflared tunnel login in the Pi's VNC browser--hostname required
Hetzner Cloud CAX31 (16GB arm64) on Ubuntu 24.04hetzner.mdsystemd user-serviceprovisioned post-install via cloudflared tunnel login in a noVNC browser reached over SSH port-forward--hostname required
macOS 14+ on Apple Siliconmacos.mdlaunchd LaunchAgentnot provisioned; operator runs cloudflared tunnel login post-install if they want public reach--hostname optional

The installer source is maxy-code/packages/create-maxy-code/. The same package is published as @rubytech/create-maxy-code and @rubytech/create-realagent-code; the publisher rewrites the package name at bundle time per brand.

Engineers reading the codebase should also see ../deployment.md for call-site detail (which branch in index.ts does what, log-line shapes, branch-by-branch decisions).