Skip to content
Documentation / Get started

Quickstart

From a new machine to a verified workspace.

1. Choose your machine

Linux runs MSO directly. macOS uses a Lima Linux guest; Windows uses WSL2; Android uses Termux with Ubuntu PRoot. iPhone and iPad connect to an existing host.

Open Terminal on Linux/macOS, PowerShell on Windows, or Termux on Android. Work as a normal non-root user.

Open the platform installation guide →

2. Install with the canonical bootstrap

Use the installer for your platform in the installation guide. It detects a supported host path, prepares dependencies, builds MSO and creates private owner configuration on a fresh install.

First-time Windows setup may require a reboot and the first launch of Ubuntu before rerunning the installer. iOS has no host installer.

3. Verify before continuing

Run these in the host terminal, inside WSL2 on Windows. Expect a printed version and a doctor report identifying real capabilities. Resolve reported errors first.

3. Verify before continuing
mso --version
mso doctor

4. Open and pair your browser

Run mso web, then open http://127.0.0.1:4005 on the same machine. On Windows use http://localhost:4005. Sign in with the owner password created during setup.

Approve the exact pending browser device from the owning host terminal. Keep using that same browser URL.

4. Open and pair your browser
mso web
Device approval and remote access →

5. Configure your first provider

The onboarding flow connects a provider and selects a model. Provider credentials are entered through private prompts. Optional apps are separate installations.

5. Configure your first provider
mso onboard
Continue to onboarding →
Full current reference

These guides orient you; use the runtime reference for complete flags and operational procedures.

Read docs/INSTALL.md on GitHub ↗

Reviewed against source 5c4f136a.