Skip to main content

Multi-agent session handoff framework for Claude Code and Codex CLI

Project description

superharness

CI PyPI version Python versions License: Apache-2.0

Multi-agent task coordination for Claude Code, Codex CLI, Gemini CLI, and OpenCode

superharness lets AI coding assistants work on the same project without stepping on each other. It provides a shared contract (SQLite-backed), queue-based delegation, lifecycle rules, and handoff/ledger state so tasks survive across sessions and auto-manage themselves.

Install as Claude Code Plugin

/plugin marketplace add artificemachine/superharness
/plugin install superharness

Gives you /shux (raw CLI passthrough), /shux-contract, /shux-status, /shux-delegate, /shux-doctor, /shux-close, plus a skill that auto-routes plain-English task/status questions to the right command.

What's New in v1.80.0

  • Harness adapter registry: claude/codex/gemini/opencode dispatch routed through a single Harness protocol, with golden-parity tests proving byte-identical invocations
  • Transcript tailing + dual watchdog: byte-offset live dispatch progress with persisted cursors, backed by idle-timeout + absolute-ceiling deadline enforcement from the event stream
  • Typed telemetry events: dedicated events table (migration v31) with a background emitter and DB-heartbeat liveness (is_fresh)
  • Dependency hygiene: CVE floors on starlette/python-multipart, a previously-undeclared requests dependency now declared, and .github/dependabot.yml for ongoing drift
  • Dashboard/CLI DB-path fix: dashboard-ui.py now resolves state.db through the same XDG-aware get_connection as the CLI, closing a silent divergence bug between the two
  • 3400+ tests preventing regressions across lifecycle, dispatch, and protocol state

⚡ 1-Minute Quickstart

Why use superharness?

  • Prevent Overlaps: Different agents (Claude, Codex, Gemini, OpenCode) won't edit the same files at the same time.
  • Persistent State: If an agent crashes or hits a limit, the next one knows exactly where to pick up.
  • Auto-Mode: Lifecycle rules auto-archive stale tasks, auto-fail deadlines, auto-close consensus discussions, and auto-clean orphans.
  • Full Visibility: shux status gives a complete health dashboard in one command.

1. Install

pipx install superharness

2. Initialize

Inside your project:

shux onboard

3. Start the Guardian

# Start background watcher (Headless default)
shux operator start

# Start with dashboard (always-on UI)
shux operator start --dashboard

4. Dashboard UI

# Launch on-demand UI (with auto-timeout)
shux dashboard

5. Check health

shux status          # Full health dashboard
shux status --fix    # Auto-clean orphans, stale items, consensus discussions
shux status --check  # CI mode (exit 1 if issues found)

Using superharness

Via Claude Code or Codex CLI (recommended)

Step 1 — Install superharness once (terminal):

pipx install superharness
Alternative: install from source
curl -fsSL https://raw.githubusercontent.com/artificemachine/superharness/main/src/superharness/scripts/install-remote.sh | bash
# export PATH="$HOME/.local/bin:$PATH"  # add to ~/.zshrc or ~/.bashrc if needed

Or clone manually:

git clone https://github.com/artificemachine/superharness.git ~/.local/share/superharness
cd ~/.local/share/superharness && pip install -e .

Step 2 — Go to your project and open Claude Code or Codex CLI.

Step 3 — Type these phrases directly to the agent:

shux explain           # what is superharness? (10-second answer — aliases: shux why, shux wtf)
shux onboard           # guided 7-step setup wizard (non-interactive: --non-interactive --git-mode team|solo)
shux init              # bootstrap .superharness/ for this project
shux doctor            # check prerequisites and protocol health
shux contract          # show all tasks with status and next-task suggestion
shux continue          # resume active contract: next resumable task + recommended action
shux delegate <id>     # create task + enqueue in one step (task must be plan_approved or later)
shux test-type <id>    # set mandatory test types for a task
shux verify <id>       # record verification result (pass/fail)
shux close <id>        # mark done (task must be report_ready or review_passed); use --cancel-remaining --cancel-reason "..." to bulk-cancel open subtasks and close atomically; --force bypasses all gates
shux subtask-cancel    # cancel a single subtask with a mandatory reason (--task <id> --sub <sub-id> --reason "...")
shux task create       # create a task with --blocked-by, --tdd-red/green/refactor, --criteria flags
shux task status       # update task lifecycle status (todo → plan_proposed → plan_approved → in_progress → report_ready → done)
shux status            # dashboard: tasks, watcher, profile
shux recall <keywords> # search past handoffs and ledger (hits >14d old get a staleness caveat; tune with --max-fresh-days)
shux distill           # distill recent handoffs+ledger into curated project lessons (--dry-run/--apply/--schedule)
shux uninstall         # remove watcher and system artifacts for this project
shux hygiene           # validate protocol compliance (contract, handoffs, ledger)
shux hygiene --repair  # auto-fix missing handoffs, ledger entries, and stuck statuses
shux dashboard         # open browser dashboard
shux watch             # start continuous watcher in foreground
shux update            # pull latest superharness + refresh templates, hooks, and watcher
shux discuss           # start or manage a cross-agent discussion (topic, owners, optional ID)
shux agent-pulse       # write/read agent liveness signal (heartbeat for running tasks)
shux auto-dispatch     # scan todo tasks, classify via model router, and enqueue to best agent
shux schedule          # cron-like scheduled dispatch: add/list/remove/run
shux install-hooks     # merge adapter hooks into ~/.claude/settings.json (portable, run once per machine)
shux init --skip-hooks # init without modifying ~/.claude/settings.json (for CI or conservative setups)
shux benchmark         # show dispatch cost/duration leaderboard (--top N, --agents, --models)
shux config get <key>  # read a profile.yaml setting (e.g. budget.daily_limit, default_model)
shux config set <key> <val>  # write a profile.yaml setting (e.g. budget.daily_limit 5.00, budget.strict true)
shux diff <id>         # preview agent changes for a task before closing (--stat, --base)
shux daemon start      # start background watcher daemon (portable, no launchd/systemd needed)
shux daemon stop       # stop the daemon
shux daemon status     # show daemon running state and PID
shux pack export       # bundle .superharness/ into a portable .tar.gz for handoff
shux pack import       # restore a pack into a new project
shux inbox-gc          # reconcile stale inbox items against contract
shux worktree-gc       # clean orphaned dispatch worktrees
shux recap             # what happened in the last N hours (timeline view)
shux notify-desktop    # send a native desktop notification
shux adapter-payload --json  # emit project state as stable JSON payload (schema v1.0) for Morpheme/adapters
shux help              # show all shux shortcuts in the terminal

Dashboard features (shux dashboard):

  • Activity feed — live timeline of dispatch, gc, and inbox events
  • Git context — branch, dirty file count, last commit in header
  • Task dependency graph — press g to toggle
  • Dispatch preview — model, effort, cost, timeout in enqueue modal
  • Keyboard shortcuts — r refresh, g graph, l list, b board, ? help

That's it. Steps 1 and 2 are one-time. From then on, shux contract starts every session.


Intelligence layer (v1.7.0)

Dispatch is now smarter. These features activate automatically — no extra setup needed.

Feature What it does
Pre-flight analysis Validates task spec, TDD block, dependencies, and git state before dispatch. Blocks on unresolved deps, warns on missing criteria.
Complexity estimator Scores acceptance criteria + TDD scope and suggests single/fanout/swarm mode.
Failure pattern matching 15 built-in classifiers (ImportError, timeout, git conflict, etc.) analyze errors and inject fix hints into the next dispatch.
Skill extraction When a task completes, extracts category, techniques, and diff stats into skills.yaml. Future dispatches for similar tasks get technique hints.
Benchmark leaderboard Tracks cost, duration, and outcome per dispatch in benchmark.jsonl. View with shux benchmark.
Parallel fan-out Run N agents concurrently on isolated git worktrees. Use fanout_dispatch() from the SDK.
Swarm mode N workers solve the same task, then an Opus reviewer picks the best solution. Optional auto-merge.

Via Terminal (alternative)

For scripting, CI, or users who prefer direct shell access.

Requires: bash, python3. See Prerequisites.

# Try first — no install needed
PYTHONPATH=src python3 -m superharness demo

# Install CLI
pipx install superharness && superharness --version

# Initialize project
cd /path/to/project
superharness init --interactive   # or: superharness init "Name" "Stack" "active"

# Verify
superharness doctor --project .

# Contract snapshot
superharness contract today --project .

# Delegate to agent
superharness delegate --to codex-cli --project .

# Queue management
superharness enqueue --project . --to codex-cli --task my-task --priority 1
superharness dispatch --project . --to codex-cli

# Protocol hygiene + browser dashboard
superharness hygiene --project .
superharness dashboard-ui --project .

Run tests:

uv sync --dev
pytest tests/ -q

Full terminal reference: docs/GUIDE.md


Quick Links

📘 User Guide — Commands, background watcher, troubleshooting 🏗️ Architecture — Why it exists, how it works, design decisions 🔒 Security — Threat model and operational safety notes


What You Get

  • shux shortcuts — Control superharness from inside Claude Code or Codex CLI
  • superharness init — Bootstrap protocol files (.superharness/); auto-installs Claude Code hooks and background watcher (macOS)
  • superharness task — Create and update tasks: --blocked-by <id> dependency tracking, --tdd-red/green/refactor TDD block, --criteria acceptance criteria; task status enforces the full lifecycle (todo → plan_proposed → plan_approved → in_progress → report_ready → done)
  • superharness delegate — Launch agent with contract context (requires task status ≥ plan_approved; auto model routing)
  • superharness verify — Record verification result before closing a task
  • superharness close — Close a verified task (requires report_ready or review_passed; use --force to bypass lifecycle gate)
  • superharness enqueue|dispatch|watch — Queue-based task routing
  • superharness hygiene — Protocol compliance checks
  • superharness watch --foreground — Cross-platform continuous watcher
  • superharness dashboard-ui — Browser dashboard: inbox, tasks, watcher state, enqueue with TDD instructions
  • superharness doctor — Prerequisite and setup health check
  • superharness uninstall — Clean removal of system artifacts
  • Background watcher — Unattended execution via macOS launchd or Linux systemd (opt-in)

Is this for me?

superharness is for you if any of these are true:

  • You use Claude Code or Codex CLI and find yourself re-explaining project context at the start of every session
  • You want to hand off a task to one agent while you work with another
  • You need an append-only audit trail of what each agent did and decided
  • You run agents unattended in the background (e.g. via launchd/systemd)

You probably don't need superharness if you only ever run a single agent interactively and don't switch between sessions.

What you need to use it

Feature Requirements
Core protocol (contracts, handoffs, ledger) bash, python3
Agent shortcuts (shux) + claude or codex CLI
Background auto-dispatch + launchd (macOS) or systemd (Linux)
Browser dashboard + python3 -m http.server (built-in)

You can start with just the core and add agent CLIs and background services later. --print-only mode lets you preview every dispatch without launching anything.


Platform Support

Cross-platform: macOS, Linux, Windows. All user-facing commands are Python and work everywhere python3 is available. CI runs on all three platforms.

  • Background watcher has automated service installers for macOS (launchd), Linux (systemd), and Windows (Task Scheduler via schtasks.exe). superharness watch --foreground works everywhere as an alternative.

Prerequisites

  • python3 3.11+ — pip install superharness (or uv sync --dev for a dev checkout). Runtime deps: click, pyyaml, ruamel.yaml, pydantic, fastmcp, requests — installed automatically.
  • bash — only needed for macOS/Linux watcher service install scripts; not required on Windows or for any core commands
  • claude CLI (for Claude delegation commands): npm install -g @anthropic-ai/claude-code
  • codex CLI (for Codex delegation commands): npm install -g @openai/codex
  • macOS launchd or Linux systemd for background watcher (see Platform Support); --foreground mode works everywhere

Project Runtime State

SQLite is the sole runtime source of truth. All task, discussion, handoff, ledger, and dispatch state lives in one state.db file:

~/.local/state/superharness/<project-hash>/state.db   # XDG path (new projects)
.superharness/state.sqlite3                            # legacy path (pre-XDG projects)

Every read and write goes through shux/superharness — never hand-edit the database or its exports directly.

.superharness/ itself holds project config plus export-only YAML artifacts, regenerated from SQLite on demand and safe to delete:

.superharness/
├── contract.yaml          # exported snapshot of tasks, decisions, failures
├── handoffs/              # exported session handoff notes
├── ledger.md              # exported append-only event log
├── decisions.yaml         # exported cross-agent ADRs
├── failures.yaml          # exported failure memory
└── inbox.yaml             # exported dispatch queue snapshot

Architecture details: docs/ARCHITECTURE.md


Repository Layout

superharness/
├── superharness            # thin Bash shim → delegates to Python
├── src/superharness/       # Python CLI + engine + command modules
├── protocol/              # protocol spec + templates
├── adapters/              # Claude/Codex adapter assets
├── src/superharness/scripts/  # installers (launchd/systemd/remote), delegate/watcher shell scripts, dashboard UI
├── scripts/               # dev-reinstall + L5 verification loop scripts
├── docs/                  # architecture and user guide
├── tests/                 # unit/integration/e2e tests
└── CHANGELOG.md

Security Note

The background watcher enables unattended execution (agents run without human supervision). This is powerful but requires explicit confirmation:

macOS (launchd):

bash src/superharness/scripts/install-launchd-inbox-watcher.sh \
  --project /path/to/project \
  --interval 30 \
  --confirm-non-interactive yes \
  --confirm-skip-permissions yes

Linux (systemd):

CONFIRM_NON_INTERACTIVE=yes bash src/superharness/scripts/install-systemd-inbox-watcher.sh \
  --project /path/to/project \
  --interval 30

Read the full threat model: SECURITY.md


Prior art and influences

superharness draws on ideas from several open agent harnesses and patterns. Each link points to the specific extraction or comparison doc.

See ATTRIBUTIONS.md for the full extract list — what each source contributed, and what we deliberately did not adopt.


Current Version

Current version: v1.80.0 — 3400+ tests, harness adapter registry, transcript tailing, dual watchdog, typed telemetry events.

See CHANGELOG.md for the full iteration log.


License

Apache License 2.0 — see LICENSE.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

superharness-1.80.1.tar.gz (692.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

superharness-1.80.1-py3-none-any.whl (813.8 kB view details)

Uploaded Python 3

File details

Details for the file superharness-1.80.1.tar.gz.

File metadata

  • Download URL: superharness-1.80.1.tar.gz
  • Upload date:
  • Size: 692.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for superharness-1.80.1.tar.gz
Algorithm Hash digest
SHA256 319517b5225c03db993cfa78cb0266ccfb0de0cbc9f5ffd6cc0a7a4259639ff0
MD5 3d4b7497b01cd1cbad53154fd116c42a
BLAKE2b-256 433d5845a9911991af11b82016d48ef6c2ef331b7c518500207e346eadd63773

See more details on using hashes here.

Provenance

The following attestation bundles were made for superharness-1.80.1.tar.gz:

Publisher: publish.yml on artificemachine/superharness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file superharness-1.80.1-py3-none-any.whl.

File metadata

  • Download URL: superharness-1.80.1-py3-none-any.whl
  • Upload date:
  • Size: 813.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for superharness-1.80.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a493cb4ddf4296e45d334030c2be03fcd9d984275544623e73fb930ca150cd20
MD5 843d4eb908bb3010d77d8af0e81cee39
BLAKE2b-256 472fb9732b7c2876d73ecc7285294a30471ceae227c2dfd3da2997c3ac6c2cd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for superharness-1.80.1-py3-none-any.whl:

Publisher: publish.yml on artificemachine/superharness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page