Documentation feedback

Help us improve this page.

About

We use submissions to improve Swarm and may reply if you include an email. Human verification is required. See our Privacy Policy.

Quickstart

Get Swarm running

Install the local daemon, start it as an always-on service, then connect your first client and finish onboarding.

Install Swarm.

Install the daemon, choose how it starts, then verify it is running.

01

Run the installer

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
02

Choose system service when prompted

The installer prints an install plan, then asks how Swarm should start. Choose the service option to install, enable, and start swarm.service so Swarm stays running.

1ServiceRecommended

Runs Swarm as an always-on background service.

2ManualStart yourself

Install Swarm, but manage start/stop manually.

3CancelExit install

Stop the installer without setting up Swarm.

03

Verify the daemon

After installation, check that the service is installed, active, and healthy.

swarm status

Connect a client.

Swarm provides two ways to connect a client to the running service.

Terminal

Open the terminal client in your project directory.

swarm
Desktop

Open the Swarm desktop client, or visit the local desktop URL.

swarm --desktop
127.0.0.1:5555

The terminal client opens in the directory where you launch it. Run swarm from your project root when you want the terminal client attached to that project.

The desktop listener defaults to 127.0.0.1:5555. Change desktop_port in swarm.conf if you need a different port, then restart Swarm. See Configuration ports.

Complete onboarding.

Terminal and desktop use the same required three-step flow. Add a workspace to finish onboarding.

1. Create user and name Swarm

Create the first local user, then choose a name for this Swarm runtime. Sessions, workspaces, permissions, and teams attach to the user.

2. Add provider authentication

Authenticate a supported AI provider: Codex, Anthropic, Fireworks, Google, or OpenRouter.

3. Add your first workspace

A workspace is required to complete onboarding. In terminal, launch swarm from your project directory. In desktop, choose or create a workspace and select its project path.

In either client, run /workspace to manage the current workspace. See Workspaces for details.

Tip: Run /auth in desktop or terminal to add another provider, and /agents to control your agents.