Getting Started
Install
cargo install --path . --bin openswarm --force
Or build from source:
git clone https://github.com/Matars/OpenSwarm.git
cd OpenSwarm
make dev
Quick start
- Launch inside any Git repository:
openswarm -
Create a worktree – press
a, select a base branch with left/right arrows, type a branch name, press Enter. The new node is auto-selected. -
Launch an agent – press
Oto pick an agent (Claude, OpenCode) orofor a plain shell. -
Work in parallel – create more worktrees, launch more agents. The graph shows all of them with live status.
-
Switch branches quickly when needed – press
b, type to filter the branch list, then Enter to switch (or create a new branch from your typed name). -
Commit and push – select a worktree, press
cto commit,pto push. -
Merge back – select a child worktree, press
mto merge into its parent. If there are conflicts, OpenSwarm offers to launch OpenCode with a prefilled conflict-resolution prompt (or you can launch another agent viaO). -
Clean up – press
d, typeyes/yorno/nin the delete confirmation (or useddto force-delete instantly), andxto prune stale entries. - Reconnect context later – if you close and reopen OpenSwarm, pressing
Oon the same worktree can reconnect the recent OpenCode session for that node (when OpenCode is your default agent).
Requirements
- Rust toolchain (stable)
- Git on PATH
- A Git repository
If the UI looks empty
- OpenSwarm now runs startup git checks and reports failures in the status line/canvas.
- Verify the launch directory is a valid git worktree:
git rev-parse --is-inside-work-tree
git rev-parse --show-toplevel
git worktree list --porcelain
- If any command fails, launch from the correct repo/worktree path and retry.