Install

Already followed Getting Started? You're all set — this page is for alternative install methods, platform-specific instructions, and maintenance.

System requirements

  • Node 22+ (the installer script will install it if missing)
  • macOS, Linux, or Windows
  • pnpm only if you build from source

On Windows, we strongly recommend running Mayros under WSL2.

Install methods

The installer script is the recommended way to install Mayros. It handles Node detection, installation, and onboarding in one step.

For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possible. Prefer a clean base OS image (for example Ubuntu LTS), then install Mayros yourself with the installer script.

Downloads the CLI, installs it globally via npm, and launches the onboarding wizard.

bash
curl -fsSL https://maryos.apilium.com/install.sh | bash

That's it — the script handles Node detection, installation, and onboarding.

To skip onboarding and just install the binary:

bash
curl -fsSL https://maryos.apilium.com/install.sh | bash -s -- --no-onboard

For all flags, env vars, and CI/automation options, see Installer internals.

Other install methods

📦

Docker

Containerized or headless deployments.

📦

Podman

Rootless container: run setup-podman.sh once, then the launch script.

📌

Nix

Declarative install via Nix.

📌

Ansible

Automated fleet provisioning.

⚡

Bun

CLI-only usage via the Bun runtime.

After install

Verify everything is working:

bash
mayros doctor         # check for config issues
mayros status         # gateway status
mayros dashboard      # open the browser UI

If you need custom runtime paths, use:

  • MAYROS_HOME for home-directory based internal paths
  • MAYROS_STATE_DIR for mutable state location
  • MAYROS_CONFIG_PATH for config file location

See Environment vars for precedence and full details.

Troubleshooting: mayros not found

Update / uninstall

📌

Updating

Keep Mayros up to date.

📌

Migrating

Move to a new machine.

📌

Uninstall

Remove Mayros completely.