Back to the homepage

Docs

Shipmates docs

Reference documentation

Reference documentation for installing, configuring, and understanding Shipmates.

The reference pages

Seven references for installing and running the crew. Every fact is sourced straight from the repo, so nothing here drifts from what the CLI actually does.

  • Install reference

    Every flag, scope, and path the installer touches — per-harness roots, the manifest, backups, verify, and uninstall.

  • How commands work

    The shared machinery under every command — worktree isolation, the CI gate, the acceptance board, merge modes, and cost discipline.

  • Harness matrix

    Which harnesses the crew runs on today, which are refused, and the safety policy behind the refusal.

  • GitHub Copilot quickstart

    Install Copilot-native agents, verify payload fidelity, and run a safe smoke test without overstating runtime proof.

  • Pi crew switch

    Keep the captain on a cloud model and put the crew on your local models, with one switch that starts off.

  • Troubleshooting

    Symptom → cause → fix for install, runtime, and upgrade problems.

  • Architecture

    Why one crew works across harnesses, and how its structured workflow and explicit quality gates fit together.