Quickstart

Choose how to run Swarm.

Local.

Install Swarm, run it locally, and connect a provider.

Container.

Use local containers for isolated child swarms, synced workspaces, and packaged local runtime workflows.

Remote.

Use a remote Linux host over SSH when Swarm needs to stay available beyond one device.

Local

Local.

Install Swarm

Linux x86_64 and WSL Ubuntu are available now through the latest-release installer. You do not need to clone the source repository to install Swarm.

curl -fsSL https://swarmagent.dev/install | sh

Start Swarm

Run the terminal UI from your current directory, or open Swarm Desktop in the browser.

swarm Starts from your current directory.

swarm --desktop Opens Swarm Desktop in the browser, using a workspace-first launcher.

Connect a provider

Run auth to connect an AI provider and start a session.

/auth

Swarm can run in multiple network configurations locally.

Configuration

Container

Container.

Install Podman or Docker

Local child swarms use Podman or Docker. Install one of those runtimes before using container-based Add Swarm workflows.

Launch managed local child swarms

From an existing local Swarm, Add Swarm can launch a child swarm into Docker or Podman, replicate selected workspaces, and keep the child managed by the parent.

Make local container setups network reachable

Local Swarm and local child containers can also be configured for LAN or VPN-reachable setups. Use swarm mode settings to publish a reachable callback endpoint instead of loopback-only defaults.

See the configuration reference for local child transport, startup mode, and advertised callback settings.

Swarm mode Configuration

Remote

Remote.

Use a remote Linux machine over SSH

The remote path prepares the image and payload locally, sends the selected workspaces and config over SSH, then attaches the remote child back to the current Swarm.

Choose the callback transport

Remote child deploy supports callback over a reachable endpoint. SSH installs the child; after launch, the child still needs a real callback path back to the master through the configured advertise_host/advertise_port.

Treat Remote as a host workflow

Remote means a Linux host you control, typically a VM or VPS. It is not a separate provider-specific runtime.