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

  1. Launch inside any Git repository:
    openswarm
    
  2. 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.

  3. Launch an agent – press O to pick an agent (Claude, OpenCode) or o for a plain shell.

  4. Work in parallel – create more worktrees, launch more agents. The graph shows all of them with live status.

  5. 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).

  6. Commit and push – select a worktree, press c to commit, p to push.

  7. Merge back – select a child worktree, press m to 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 via O).

  8. Clean up – press d, type yes/y or no/n in the delete confirmation (or use dd to force-delete instantly), and x to prune stale entries.

  9. Reconnect context later – if you close and reopen OpenSwarm, pressing O on 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.

This site uses Just the Docs, a documentation theme for Jekyll.