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.

5 Minute Guide

Section 01

Understanding Swarm (the agent)

Swarm has two models

PlanPlan Model
DefaultDefault Model

Start in Plan Mode

DesktopClick the Plan Mode icon

TUIShiftTab

Start in Default Mode

When Plan Mode is not active, Swarm will use your Default Model.

Change models in /agents

In both Desktop and TUI, open /agents to change your models and system-agent model assignments at any time.

Section 02

Starting Sessions

Choose direct or worktree

DirectCurrent workspace

Work in your current checkout and follow along with Swarm.

IsolatedWorktree

Keep changes separate until you are ready to review and integrate them.

Start an interactive session

Desktop & TUI
Shift+TabTurn on Plan/wt onTurn on Worktree
Desktop also
Select PlanSelect Worktree

Start a background task

In Desktop or TUI, use a durable background task when you want Swarm to work separately while you remain in your current session.

/task <request>Default mode in a worktree

/task plan <request>Plan mode in a worktree

Section 03

System Agents

Deploy through Swarm

Ask Swarm to deploy a system agent when a task benefits from focused research, isolated implementation, or distinct design directions.

Finder

Researches repositories and the web, maps architecture and execution paths, and returns evidence-backed findings. Ask Swarm to deploy Finder for a focused research question.

“Use Finders to investigate this bug across multiple areas.”

Coder

Implements a dependency-ready scope in an isolated worktree, commits completed changes, and returns a clean handoff. Ask Swarm to deploy Coder for well-defined implementation work.

“Use Coders to implement these independent changes in parallel.”

Designer

Creates reusable design variants as managed artifacts by default, or edits an explicit workspace target when repository output is required. Ask Swarm for Designer iterations when you want distinct visual directions to compare.

“Use Designers to create three distinct interface directions.”

Utility agents

Swarm uses these focused helpers behind the scenes.

Compact

Condenses context or produces a title in a tool-free, one-shot pass.

Router

Generates concise session titles and portable worktree names, and specializes Iteration Swarm assignments and image briefs inside your approved requirements.

Section 04

Managing Changes

Commit your changes

Ask Swarm to commit your changes, commit them manually in Desktop or the TUI, or save time with AI Commit.

Desktop
Commit changesAI Commit
TUI
/commit <message>Commit changes/commit aiAI Commit

Bring a finished worktree home

Integrate worktree changes (Desktop)

Follow the review path from the completed session to your target branch.

01Review Queue

Needs Review

Finished sessions that need attention appear here, including worktrees with uncommitted changes and committed changes not yet integrated.

02Open Review

Manage

Select Manage beside the Needs Review heading to open Review worktrees for the current workspace.

03Safety Check

Review worktrees

Swarm compares each worktree with its detected target, keeping dirty or unintegrated work in review and marking safely integrated work as Done.

04Detected Target

Integrate into target

For a clean, committed worktree, select the offered Integrate into action. Swarm supplies the target from the matching current checkout or the worktree’s managed base branch.

05Confirm Action

Confirm integration

Confirm to integrate only, or choose Integrate and Archive to archive the session only after integration succeeds.

Archive after integration

Archive the session after Swarm verifies the worktree is integrated, or use the archive-after-integration option when it is available.