Getting Started

Goal: go from zero to a first working chat with minimal setup.

Fastest chat: open the Control UI (no channel setup needed). Run mayros dashboard and chat in the browser, or open http://127.0.0.1:18789/ on the gateway hostThe machine running the Mayros gateway service.. Docs: Dashboard and Control UI.

Prereqs

  • Node 22 or newer

Check your Node version with node --version if you are unsure.

Quick setup (CLI)

1

Install Mayros (recommended)

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

Other install methods and requirements: Install.

2

Run the onboarding wizard

bash
mayros onboard --install-daemon

The wizard configures auth, gateway settings, and optional channels. See Onboarding Wizard for details.

3

Check the Gateway

If you installed the service, it should already be running:

bash
mayros gateway status
4

Open the Control UI

bash
mayros dashboard

If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Useful environment variables

If you run Mayros as a service account or want custom config/state locations:

  • MAYROS_HOME sets the home directory used for internal path resolution.
  • MAYROS_STATE_DIR overrides the state directory.
  • MAYROS_CONFIG_PATH overrides the config file path.

Full environment variable reference: Environment vars.

Go deeper

Onboarding Wizard (details)

Full CLI wizard reference and advanced options.

macOS app onboarding

First run flow for the macOS app.

What you will have

  • A running Gateway
  • Auth configured
  • Control UI access or a connected channel

Next steps

  • DM safety and approvals: Pairing
  • Connect more channels: Channels
  • Advanced workflows and from source: Setup