spec2test 0.1.1__tar.gz

spec2test-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 spec2test contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

spec2test-0.1.1/PKG-INFO

@@ -0,0 +1,397 @@
+Metadata-Version: 2.4
+Name: spec2test
+Version: 0.1.1
+Summary: AI drafts test cases from a plain-English requirement; a human approves or rejects each one; only approved cases become real, running code — and a mutation harness proves the result actually catches bugs.
+Author: spec2test contributors
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the
+              purposes of this License, Derivative Works shall not include works
+              that remain separable from, or merely link (or bind by name) to the
+              interfaces of, the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including the
+              original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing
+              the origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2026 spec2test contributors
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/Koustubh-AI-LAB/spec2test
+Project-URL: Issues, https://github.com/Koustubh-AI-LAB/spec2test/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langgraph>=1.2.11
+Requires-Dist: langchain-core>=1.5.4
+Requires-Dist: langchain-openai>=1.5.0
+Requires-Dist: langchain-ollama>=1.1.0
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pydantic-settings>=2.15.0
+Requires-Dist: fastapi>=0.141.1
+Requires-Dist: python-multipart>=0.0.31
+Requires-Dist: uvicorn[standard]>=0.52.3
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: psycopg[binary]>=3.3.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: python-dotenv>=1.2.2
+Requires-Dist: pytest>=9.1.1
+Requires-Dist: pytest-json-report>=1.5.0
+Provides-Extra: ui
+Requires-Dist: playwright>=1.62.0; extra == "ui"
+Dynamic: license-file
+
+# spec2test
+
+**AI writes your tests. spec2test proves they actually catch bugs.**
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+## What is spec2test?
+
+spec2test turns a plain-English requirement into a real, executed test — with a human approving every test before it runs, and a built-in way to *prove* the test actually catches the bug it's supposed to catch.
+
+Every AI test-generation tool claims "our AI writes good tests." None of them prove it — a generated test that passes tells you nothing if it isn't checking anything meaningful. spec2test proves it with a **mutation harness**: it deliberately breaks a rule in your application on purpose, then confirms that the *correct* test — and only that one — fails, attributed to the *correct* requirement.
+
+```
+Requirement                    "A member may hold at most 3 books at once"
+     │
+     ▼
+AI drafts test cases          happy path · boundary case · negative case
+     │
+     ▼
+Human approves or rejects     nothing downstream touches an unapproved case
+     │
+     ▼
+Code generation                pytest + httpx, validated: real assertions,
+     │                         no disallowed imports, AST-checked
+     ▼
+Execution                      runs against your target app
+     │
+     ▼
+Mutation proof                 deliberately break the rule → the correct
+                                test fails, and only that one
+```
+
+## Why the human checkpoint matters
+
+An AI can write a test that *looks* correct, runs, and passes — while checking the wrong thing entirely. That's worse than no test: it gives false confidence. spec2test's rule: no AI-drafted test becomes real, executable code until a human has approved it.
+
+## Why the mutation harness matters more
+
+The approval gate is a safety rail, not the differentiator — AI-drafts-into-a-review-queue is table stakes by now. The mutation harness is the actual product: a reproducible experiment, not a marketing claim. Most tools don't own both the requirement and the target application, so they have no basis to attribute a test failure to anything at all.
+
+The LLM sits *upstream* of the human approval gate. The artifact that matters — the thing that gets executed, versioned, and re-run — is the human-approved test, never the LLM's raw output.
+
+## How to use it
+
+### 1. What you'll need
+
+- Python 3.12+
+- An LLM to draft test cases: either a **Groq API key** (there's a free tier — [console.groq.com](https://console.groq.com)) or a **local [Ollama](https://ollama.com)** install. spec2test never provides or proxies LLM access itself — you bring your own key or your own local model, and only your own machine ever talks to it.
+- Your own application to test against — spec2test doesn't generate the app under test, only the tests for it. It needs to expose a small contract (below).
+
+### 2. Install and initialize
+
+```bash
+pip install spec2test
+spec2test init
+```
+
+`init` scaffolds two things in your current directory: `specs/example.yaml` (a template showing the shape a requirement needs) and `.env` (where your LLM credentials and target app URL go).
+
+### 3. Make your target app testable
+
+Your app needs three things spec2test can call:
+
+- A **health check** — `GET /health` returning `200` once your app is up.
+- A **reset endpoint** — `POST /_test/reset`, idempotent, that puts your app back to a known clean state before each test run. Gate this behind an explicit flag in your own app (e.g. only mounted when `TESTFORGE_MODE=1` or similar) — never something that could be reachable in production.
+- A **mutations registry** — a small Python module listing the named "bugs" you've deliberately wired into your app's own source, each behind a check like `os.environ.get("SPEC2TEST_MUTATION") == "no-fourth-loan"(this was just for example from book lending target app that i tested Spec2Test on)`. This is what the mutation harness flips on and off.
+
+Then point `.env` at it:
+```
+TARGET_BASE_URL=http://localhost:8000
+MUTATIONS_MODULE=my_app.mutations
+```
+
+### 4. Draft, review, and prove
+
+```bash
+spec2test generate                          # AI drafts test cases from specs/*.yaml
+spec2test review decide --reviewer "<you>"  # walk through each draft: approve, reject, or skip
+spec2test mutate --case <name>              # break a rule on purpose - confirm the right test catches it
+spec2test report                            # a traceability matrix: every requirement, every case, every result
+```
+
+Prefer a browser over the terminal? `spec2test dashboard` gives you the same review/generate/mutate/report workflow as a local web UI.
+
+## Command reference
+
+**Setup** — run once per project:
+```bash
+spec2test init [--dir DIR]   # scaffolds specs/example.yaml + .env (default: current directory)
+```
+
+**Core workflow** — run in this order:
+```bash
+spec2test generate [--requirement REQ_ID] [--force] [--extra-spec-dir DIR]
+# AI drafts test cases from specs/*.yaml into artifacts/review.yaml.
+# --requirement: only draft for one requirement. --force: redraft even if
+# that requirement already has cases. --extra-spec-dir: also read from
+# another directory (repeatable).
+
+spec2test review decide --reviewer "<name>" [--path artifacts/review.yaml]
+# Interactive, in the terminal: approve/reject/skip each proposed case.
+# Approved cases move to artifacts/approved/.
+
+spec2test review apply --reviewer "<name>" [--path artifacts/review.yaml]
+# Non-interactive alternative to `decide` - applies status: fields you
+# already hand-edited into review.yaml yourself.
+
+spec2test mutate --case <name>
+# Deliberately breaks one named rule in your target app, confirms the
+# right approved test - and only that one - catches it. <name> must
+# match an entry in your mutations_module's registry.
+
+spec2test report [--only-case CASE_ID ...]
+# Runs the full approved suite, writes artifacts/reports/report.json /
+# report.html / results.json - a traceability matrix covering every
+# requirement, including ones with zero or not-yet-approved cases.
+# --only-case: restrict to specific case IDs (repeatable); omit for all.
+```
+
+**Browser UI**, as an alternative to the CLI commands above:
+```bash
+spec2test dashboard [--host 127.0.0.1] [--port PORT]
+# Doesn't auto-open a browser - navigate to the printed URL yourself.
+```
+
+**Pulling requirements from Jira/ClickUp** instead of hand-writing `specs/*.yaml`:
+```bash
+spec2test extract fetch --source {jira|clickup|file} --query "<query>" [--force-refetch]
+# Fetches issues and drafts candidate REQUIREMENTS (not test cases) into
+# artifacts/extraction_review.yaml. --query: a JQL string / issue key
+# (Jira), a list ID (ClickUp), or a file path. --force-refetch: redraft
+# an issue even if it was already fetched before.
+
+spec2test extract apply --reviewer "<name>" [--path artifacts/extraction_review.yaml]
+# Applies your approve/reject decisions, writing approved requirements
+# into specs/extracted/ - which `generate` then reads exactly like a
+# hand-written specs/*.yaml file.
+```
+
+## Architecture, briefly
+
+- **Core pipeline** — requirement loader, LLM provider chain (Groq or a local Ollama model), test-case generator, human review gate, structured logging. The same code path handles every target, with no special-casing per target type.
+- **Adapters** — an API adapter (pytest + httpx) and a UI adapter (pytest + Playwright), dispatched through one shared registry, sharing the same codegen-validation logic.
+- **Your target app** — never bundled. spec2test tests against an app you point it at; the repo ships its own small demo app purely so the tool can test itself.
+
+## What spec2test is not
+
+- Not a tool for testing real, live systems — sandbox-only, enforced with no override.
+- Not "fully autonomous testing" — a human has final say before anything becomes an executed test.
+- Not tied to one AI provider — the backend swaps (cloud or local model) without touching the rest of the pipeline.
+- Not a claim of DO-330/ISO 26262 tool qualification — the architecture aligns with the traceability model safety-critical software is held to, but qualification requires a kit this project doesn't (yet) provide.
+
+## Contributing
+
+Building or modifying spec2test itself? See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full dev setup (running from a clone, the test suite, Docker). Security issues: see [`SECURITY.md`](SECURITY.md) — please don't open a public issue for those.
+
+## License
+
+Apache License 2.0 — see [`LICENSE`](LICENSE).