Skip to content

Installation

Prerequisites

  • Bun v1.0 or later
  • Git 2.20 or later (for worktree support)
  • At least one AI coding agent installed:

Install from Source

Clone the repository and install globally:

bash
git clone https://github.com/workstream-labs/workstreams.git
cd workstreams
bun install
bun link

This makes the ws command available globally.

Verify Installation

bash
ws --help

You should see the list of available commands:

Usage: ws [options] [command]

Orchestrate parallel AI coding agents

Commands:
  init              Initialize workstreams in this repo
  create <name>     Add a new workstream
  run [name]        Run workstreams
  list              Show workstream status
  switch [name]     Open interactive dashboard
  diff [name]       View workstream changes
  merge [name]      Merge workstream into current branch
  resume <name>     Resume a workstream with new instructions
  destroy [name]    Remove a workstream
  logs [name]       View agent logs
  prompt <name>     Set or update a workstream prompt

Next Steps

Head to the Quickstart to run your first parallel workstream.

Built with VitePress