Skip to content
Install & apps

02 / Start

Install & apps

Start in the managed web app. Use a desktop app for supported device capabilities and a companion app for supported mobile actions. Each installed version has its own connection and permission steps.

Web app macOS · Windows · Linux Phone & Watch companions

The web app

Open Muster in your browser and complete the sign-in and setup steps shown. Muster is a free app; bring your own provider API key and pay the provider for usage. You do not need a separate server deployment. See Account & device setup.

Desktop downloads

Use the download page for the current version, available platforms and release-specific installation information. Keep your existing workspace data when upgrading.

PlatformPackageFirst step
macOS — Apple SiliconApple Silicon downloadInstall the package intended for your Mac.
macOS — IntelIntel downloadCheck architecture and release availability.
Windows (x64)Windows installerReview the installer and publisher information.
Ubuntu / Debian (x64)Debian packageInstall the package and its required desktop dependencies.
Linux (x64)AppImageUse the supported runtime and architecture shown for that release.

First launch and updates

Open the installed app and follow its account, provider and permission steps. Signing, notarization and operating-system compatibility are specific to each package. If a package fails a platform check, confirm the download and release instructions before proceeding.

Where the installed version offers an update, review its in-app controls and restart when you are ready. Updating the website does not update an installed desktop or companion app.

Device capabilities

Supported desktop versions can use local agent CLIs, local models, files and computer controls. Those features run where the device tools are available, with the permissions you grant. A web sign-in alone does not make your laptop's tools available to a hosted bot.

Keep the selected computer online for work that needs it. Capabilities differ by operating system, installed version and runtime; check the available controls rather than assuming every platform offers the same tools.

Phone and Watch companions

Companion availability and distribution are separate from the desktop downloads. Use a supported build and its pairing flow to connect the intended workspace or computer. Approval delivery and replies need an available connection; an installed app alone does not establish pairing.

Companions may retain local credentials, drafts or cached content. They are not complete backups of the workspace. Confirm the correct account and destination before sending a task or answering an approval.

The Muster CLI

The distributed CLI can operate an authorized workspace through commands such as pair, bots, send, status and receipts. Obtain it through the official downloads, use muster help for that version, and read For agents before connecting another agent. Public npm packages with similar names are not an installation path for Muster.

Existing desktop data Released desktop versions can keep an installation-specific workspace, commonly under ~/.muster, along with separate app-profile data. Hosted workspace records live on the service. Matching account sign-ins do not prove that these records or provider keys have been migrated or synchronized.

Continue with Quick start or review Account & device setup before connecting more devices.