Skip to main content

testboat

Manage tests like code — CLI + AI agent skill for the complete testing lifecycle.

PyPI version Python License Tests


The Problem

Testing is still managed with scattered spreadsheets, Confluence pages, and tribal knowledge. Test cases drift from requirements, execution results are never recorded, and every sprint the team starts from scratch.

WITHOUT testboat

  Strategy lives in a Word doc nobody reads.
  Test cases are in an Excel sheet from 2 years ago.
  "Did we test this?" — nobody knows.
  AI writes automation but nobody tracks coverage.
WITH testboat

  Strategy, test cases, execution results, bugs — all structured YAML.
  AI generates test cases from requirements, executes automation, files bugs.
  testboat validate checks coverage and exit criteria before any report.
  One source of truth. Git-diffable. Always up to date.

How It Works

testboat manages a structured filesystem under .testboat/ in your workspace:

.testboat/
  .active          ← current working version (draft / v1.0 / ...)
  draft/
    strategy.yaml  ← test strategy (scope, risk matrix, exit criteria)
    tags.yaml      ← sprint / type / module tag registry
    cases/         ← TC-001.yaml, TC-002.yaml, ...
    bugs/          ← BUG-001.yaml, BUG-002.yaml, ...
    executions/
      plans/       ← TC-001-plan.yaml (how to execute each TC)
      results/     ← RES-001.yaml (execution results)
      automate/    ← standalone automation sub-projects
    reports/       ← sprint/closure HTML reports

CLI enforces structure and state machines. AI agent generates content, runs automation, and communicates results. Both operate on the same files.


Quick Start

pip install testboat

# Initialize workspace
testboat init

# Activate agent skill (Claude, Copilot, Cursor, Trae, Kiro, etc.)
testboat enable claude

# Create test strategy
testboat strategy create
# → edit .testboat/draft/strategy.yaml, then:
testboat strategy validate

# Add tags and test cases
testboat tag add sprint v1.0
testboat tag add module auth
testboat case add --title "Login with wrong password returns 401" \
               --sprint v1.0 --type functional --module auth --req-id STORY-001

# Create execution plan and run
testboat plan create TC-001 --type automated --tool pytest
testboat plan register TC-001 .testboat/draft/executions/automate/pytest/tests/test_TC001.py
testboat plan status TC-001 approved

# Record result and file bugs
testboat result record TC-001 pass --type automated
testboat bug add --title "Login 500 error" --tc TC-001 --severity critical --priority P0

# Pre-report validation
testboat validate

# Generate and preview reports
testboat report strategy && testboat report sprint && testboat report closure
testboat preview

Commands

Command Description
testboat init Initialize .testboat/ workspace
testboat enable <agent> Create agent rules + skill files
testboat version create/switch/list Manage named versions
testboat strategy create/validate Test strategy lifecycle
testboat tag add/list Manage sprint / type / module tags
testboat case add/list/show/status/validate Test case CRUD + state machine
testboat plan create/register/status Execution plan management
testboat result record/list Record execution results
testboat matrix show Global execution tracking
testboat bug add/list/status Bug lifecycle
testboat validate Pre-report health check
testboat report strategy/sprint/closure Generate HTML reports
testboat preview Local report preview server

Supported Agents

Agent Files created
Claude / OpenCode .claude/rules/testboat.md + .claude/skills/testboat/SKILL.md
GitHub Copilot .github/instructions/testboat.instructions.md
Cursor .cursor/rules/testboat.md + .cursor/skills/testboat/SKILL.md
Trae .trae/rules/testboat.md + .trae/skills/testboat/SKILL.md
Kiro .kiro/steering/testboat.md
OpenClaw skills/testboat/SKILL.md

Requirements

  • Python ≥ 3.11
  • Works with any AI agent that supports custom instructions / skills

License

Apache 2.0

Metadata

Release files for testboat 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for testboat 1.0.4
File Size Uploaded Provenance
testboat-1.0.4.tar.gz 105.3 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for testboat 1.0.4
File Interpreter ABI Platform
testboat-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 194.3 kB

Release files / testboat-1.0.4.tar.gz

Download URL testboat-1.0.4.tar.gz
Size 105.3 kB
Tags Source
SHA-256 checksum
How to use checksums
4345530ccfab01f9c315808bd15e135593636c7078711d79c8693d6fb9f8f04b
BLAKE2b-256 checksum
How to use checksums
ecba51c09d861b3222c06f60bf2e468bf5be2380a6abc06ebdda9406c8e7f411
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 28, 2026.

Transparency log

Release files / testboat-1.0.4-py3-none-any.whl

Download URL testboat-1.0.4-py3-none-any.whl
Size 89.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c27d646f1e5620f70145c174074253be805adb47e8c9b37a8ac3347d0046f8c0
BLAKE2b-256 checksum
How to use checksums
55ce905995257706ef2d230eaedc7a5b696d58c9830c856ec27f09afcdaa7091
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 28, 2026.

Transparency log

Security for testboat 1.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for testboat-1.0.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 28, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page