Quickstart (5–15 minutes)

Prerequisites: Python 3.10+, git, and a GitHub repo where you can add workflows.

Install (from GitHub while package is being published):

# install directly from the monorepo (editable for development)
pip install -e tools/issuetest
# or install from the Git repo when published:
# pip install git+https://github.com/SuperIntelliMachines/issuetest.git

Bootstrap your repo with issuetest init:

# from repo root
issuetest init
# if files already exist and you want to overwrite
issuetest init --force

What init adds (≤7 files): - .issuetest.yml — example config - .github/ISSUE_TEMPLATE/test-case.yml — issue form - .github/workflows/issuetest-sync.yml - .github/workflows/issuetest-validate.yml - .github/workflows/issuetest-run.yml - .github/labels.yml - docs/test-cases/.gitkeep

Edit .issuetest.yml to set github.repo and any fixture/imports your project requires. Verify config:

issuetest doctor

Sync issues to YAML (dry-run):

issuetest sync --dry-run

Validate your cases and matrix:

issuetest validate

Run tests locally (writes .issuetest/run_report.json):

issuetest run

Preview the report (dry-run):

issuetest report --dry-run

For CI, use the reusable composite actions in action/* (once published as @v1) or commit the workflows issuetest init created.