Skip to content

Quick Start

Prerequisites

RequirementVersionInstall
tmux3.2+brew install tmux
jqanybrew install jq
Claude Code CLIlatestnpm install -g @anthropic-ai/claude-code
Node.js20+For hooks
GitanyFor installation

Installation

Interactive installer that sets up tmux config, Claude Code settings, hooks, and the shipwright CLI:

Terminal window
git clone https://github.com/sethdford/shipwright.git
cd shipwright
./install.sh

Your First Team Session

  1. Start tmux

    Terminal window
    tmux new -s dev
  2. Launch a team session with a template

    Terminal window
    shipwright session my-feature --template feature-dev

    This creates a 3-agent team (backend, frontend, tests) with the leader pane taking 65% of the screen.

  3. Start coding with Claude

    Terminal window
    claude

    Tell Claude what you want to build. It will coordinate the agents across tmux panes.

  4. Monitor your team

    Terminal window
    shipwright status # Team dashboard
    shipwright ps # Running agent processes

    Or press Ctrl-a then Ctrl-t for an inline dashboard.

Verify Your Setup

Run the built-in doctor to check everything is configured correctly:

Terminal window
shipwright doctor

This checks tmux version, jq availability, overlay hooks, color configuration, and orphaned sessions.

What’s Next?