specfact-cli 0.4.2__py3-none-any.whl → 0.6.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. specfact_cli/__init__.py +1 -1
  2. specfact_cli/agents/analyze_agent.py +2 -3
  3. specfact_cli/analyzers/__init__.py +2 -1
  4. specfact_cli/analyzers/ambiguity_scanner.py +601 -0
  5. specfact_cli/analyzers/code_analyzer.py +462 -30
  6. specfact_cli/analyzers/constitution_evidence_extractor.py +491 -0
  7. specfact_cli/analyzers/contract_extractor.py +419 -0
  8. specfact_cli/analyzers/control_flow_analyzer.py +281 -0
  9. specfact_cli/analyzers/requirement_extractor.py +337 -0
  10. specfact_cli/analyzers/test_pattern_extractor.py +330 -0
  11. specfact_cli/cli.py +151 -206
  12. specfact_cli/commands/constitution.py +281 -0
  13. specfact_cli/commands/enforce.py +42 -34
  14. specfact_cli/commands/import_cmd.py +481 -152
  15. specfact_cli/commands/init.py +224 -55
  16. specfact_cli/commands/plan.py +2133 -547
  17. specfact_cli/commands/repro.py +100 -78
  18. specfact_cli/commands/sync.py +701 -186
  19. specfact_cli/enrichers/constitution_enricher.py +765 -0
  20. specfact_cli/enrichers/plan_enricher.py +294 -0
  21. specfact_cli/importers/speckit_converter.py +364 -48
  22. specfact_cli/importers/speckit_scanner.py +65 -0
  23. specfact_cli/models/plan.py +42 -0
  24. specfact_cli/resources/mappings/node-async.yaml +49 -0
  25. specfact_cli/resources/mappings/python-async.yaml +47 -0
  26. specfact_cli/resources/mappings/speckit-default.yaml +82 -0
  27. specfact_cli/resources/prompts/specfact-enforce.md +185 -0
  28. specfact_cli/resources/prompts/specfact-import-from-code.md +626 -0
  29. specfact_cli/resources/prompts/specfact-plan-add-feature.md +188 -0
  30. specfact_cli/resources/prompts/specfact-plan-add-story.md +212 -0
  31. specfact_cli/resources/prompts/specfact-plan-compare.md +571 -0
  32. specfact_cli/resources/prompts/specfact-plan-init.md +531 -0
  33. specfact_cli/resources/prompts/specfact-plan-promote.md +352 -0
  34. specfact_cli/resources/prompts/specfact-plan-review.md +1276 -0
  35. specfact_cli/resources/prompts/specfact-plan-select.md +401 -0
  36. specfact_cli/resources/prompts/specfact-plan-update-feature.md +242 -0
  37. specfact_cli/resources/prompts/specfact-plan-update-idea.md +211 -0
  38. specfact_cli/resources/prompts/specfact-repro.md +268 -0
  39. specfact_cli/resources/prompts/specfact-sync.md +497 -0
  40. specfact_cli/resources/schemas/deviation.schema.json +61 -0
  41. specfact_cli/resources/schemas/plan.schema.json +204 -0
  42. specfact_cli/resources/schemas/protocol.schema.json +53 -0
  43. specfact_cli/resources/templates/github-action.yml.j2 +140 -0
  44. specfact_cli/resources/templates/plan.bundle.yaml.j2 +141 -0
  45. specfact_cli/resources/templates/pr-template.md.j2 +58 -0
  46. specfact_cli/resources/templates/protocol.yaml.j2 +24 -0
  47. specfact_cli/resources/templates/telemetry.yaml.example +35 -0
  48. specfact_cli/sync/__init__.py +10 -1
  49. specfact_cli/sync/watcher.py +268 -0
  50. specfact_cli/telemetry.py +440 -0
  51. specfact_cli/utils/acceptance_criteria.py +127 -0
  52. specfact_cli/utils/enrichment_parser.py +445 -0
  53. specfact_cli/utils/feature_keys.py +12 -3
  54. specfact_cli/utils/ide_setup.py +170 -0
  55. specfact_cli/utils/structure.py +179 -2
  56. specfact_cli/utils/yaml_utils.py +33 -0
  57. specfact_cli/validators/repro_checker.py +22 -1
  58. specfact_cli/validators/schema.py +15 -4
  59. specfact_cli-0.6.8.dist-info/METADATA +456 -0
  60. specfact_cli-0.6.8.dist-info/RECORD +99 -0
  61. {specfact_cli-0.4.2.dist-info → specfact_cli-0.6.8.dist-info}/entry_points.txt +1 -0
  62. specfact_cli-0.6.8.dist-info/licenses/LICENSE.md +202 -0
  63. specfact_cli-0.4.2.dist-info/METADATA +0 -370
  64. specfact_cli-0.4.2.dist-info/RECORD +0 -62
  65. specfact_cli-0.4.2.dist-info/licenses/LICENSE.md +0 -61
  66. {specfact_cli-0.4.2.dist-info → specfact_cli-0.6.8.dist-info}/WHEEL +0 -0
@@ -0,0 +1,456 @@
1
+ Metadata-Version: 2.4
2
+ Name: specfact-cli
3
+ Version: 0.6.8
4
+ Summary: Brownfield-first CLI: Reverse engineer legacy Python → specs → enforced contracts. Automate legacy code documentation and prevent modernization regressions.
5
+ Project-URL: Homepage, https://github.com/nold-ai/specfact-cli
6
+ Project-URL: Repository, https://github.com/nold-ai/specfact-cli.git
7
+ Project-URL: Documentation, https://github.com/nold-ai/specfact-cli#readme
8
+ Project-URL: Issues, https://github.com/nold-ai/specfact-cli/issues
9
+ Project-URL: Trademarks, https://github.com/nold-ai/specfact-cli/blob/main/TRADEMARKS.md
10
+ Author-email: "NOLD AI (Owner: Dominikus Nold)" <hello@noldai.com>
11
+ License: Apache License
12
+ Version 2.0, January 2004
13
+ http://www.apache.org/licenses/
14
+
15
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
16
+
17
+ 1. Definitions.
18
+
19
+ "License" shall mean the terms and conditions for use, reproduction,
20
+ and distribution as defined by Sections 1 through 9 of this document.
21
+
22
+ "Licensor" shall mean the copyright owner or entity authorized by
23
+ the copyright owner that is granting the License.
24
+
25
+ "Legal Entity" shall mean the union of the acting entity and all
26
+ other entities that control, are controlled by, or are under common
27
+ control with that entity. For the purposes of this definition,
28
+ "control" means (i) the power, direct or indirect, to cause the
29
+ direction or management of such entity, whether by contract or
30
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
31
+ outstanding shares, or (iii) beneficial ownership of such entity.
32
+
33
+ "You" (or "Your") shall mean an individual or Legal Entity
34
+ exercising permissions granted by this License.
35
+
36
+ "Source" form shall mean the preferred form for making modifications,
37
+ including but not limited to software source code, documentation
38
+ source, and configuration files.
39
+
40
+ "Object" form shall mean any form resulting from mechanical
41
+ transformation or translation of a Source form, including but
42
+ not limited to compiled object code, generated documentation,
43
+ and conversions to other media types.
44
+
45
+ "Work" shall mean the work of authorship, whether in Source or
46
+ Object form, made available under the License, as indicated by a
47
+ copyright notice that is included in or attached to the work
48
+ (which shall not include Communications that are clearly marked or
49
+ otherwise designated in writing by the copyright owner as "Not a Work").
50
+
51
+ "Derivative Works" shall mean any work, whether in Source or Object
52
+ form, that is based on (or derived from) the Work and for which the
53
+ editorial revisions, annotations, elaborations, or other modifications
54
+ represent, as a whole, an original work of authorship. For the purposes
55
+ of this License, Derivative Works shall not include works that remain
56
+ separable from, or merely link (or bind by name) to the interfaces of,
57
+ the Work and Derivative Works thereof.
58
+
59
+ "Contribution" shall mean any work of authorship, including
60
+ the original version of the Work and any modifications or additions
61
+ to that Work or Derivative Works thereof, that is intentionally
62
+ submitted to Licensor for inclusion in the Work by the copyright owner
63
+ or by an individual or Legal Entity authorized to submit on behalf of
64
+ the copyright owner. For the purposes of this definition, "submitted"
65
+ means any form of electronic, verbal, or written communication sent
66
+ to the Licensor or its representatives, including but not limited to
67
+ communication on electronic mailing lists, source code control systems,
68
+ and issue tracking systems that are managed by, or on behalf of, the
69
+ Licensor for the purpose of discussing and improving the Work, but
70
+ excluding communication that is clearly marked or otherwise designated
71
+ in writing by the copyright owner as "Not a Contribution".
72
+
73
+ "Contributor" shall mean Licensor and any individual or Legal Entity
74
+ on behalf of whom a Contribution has been received by Licensor and
75
+ subsequently incorporated within the Work.
76
+
77
+ 2. Grant of Copyright License. Subject to the terms and conditions of
78
+ this License, each Contributor hereby grants to You a perpetual,
79
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
80
+ copyright license to reproduce, prepare Derivative Works of,
81
+ publicly display, publicly perform, sublicense, and distribute the
82
+ Work and such Derivative Works in Source or Object form.
83
+
84
+ 3. Grant of Patent License. Subject to the terms and conditions of
85
+ this License, each Contributor hereby grants to You a perpetual,
86
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
87
+ (except as stated in this section) patent license to make, have made,
88
+ use, offer to sell, sell, import, and otherwise transfer the Work,
89
+ where such license applies only to those patent claims licensable
90
+ by such Contributor that are necessarily infringed by their
91
+ Contribution(s) alone or by combination of their Contribution(s)
92
+ with the Work to which such Contribution(s) was submitted. If You
93
+ institute patent litigation against any entity (including a
94
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
95
+ or a Contribution incorporated within the Work constitutes direct
96
+ or contributory patent infringement, then any patent licenses
97
+ granted to You under this License for that Work shall terminate
98
+ as of the date such litigation is filed.
99
+
100
+ 4. Redistribution. You may reproduce and distribute copies of the
101
+ Work or Derivative Works thereof in any medium, with or without
102
+ modifications, and in Source or Object form, provided that You
103
+ meet the following conditions:
104
+
105
+ (a) You must give any other recipients of the Work or
106
+ Derivative Works a copy of this License; and
107
+
108
+ (b) You must cause any modified files to carry prominent notices
109
+ stating that You changed the files; and
110
+
111
+ (c) You must retain, in the Source form of any Derivative Works
112
+ that You distribute, all copyright, patent, trademark, and
113
+ attribution notices from the Source form of the Work,
114
+ excluding those notices that do not pertain to any part of
115
+ the Derivative Works; and
116
+
117
+ (d) If the Work includes a "NOTICE" text file as part of its
118
+ distribution, then any Derivative Works that You distribute must
119
+ include a readable copy of the attribution notices contained
120
+ within such NOTICE file, excluding those notices that do not
121
+ pertain to any part of the Derivative Works, in at least one
122
+ of the following places: within a NOTICE text file distributed
123
+ as part of the Derivative Works; within the Source form or
124
+ documentation, if provided along with the Derivative Works; or,
125
+ within a display generated by the Derivative Works, if and
126
+ wherever such third-party notices normally appear. The contents
127
+ of the NOTICE file are for informational purposes only and
128
+ do not modify the License. You may add Your own attribution
129
+ notices within Derivative Works that You distribute, alongside
130
+ or as an addendum to the NOTICE text from the Work, provided
131
+ that such additional attribution notices cannot be construed
132
+ as modifying the License.
133
+
134
+ You may add Your own copyright statement to Your modifications and
135
+ may provide additional or different license terms and conditions
136
+ for use, reproduction, or distribution of Your modifications, or
137
+ for any such Derivative Works as a whole, provided Your use,
138
+ reproduction, and distribution of the Work otherwise complies with
139
+ the conditions stated in this License.
140
+
141
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
142
+ any Contribution intentionally submitted for inclusion in the Work
143
+ by You to the Licensor shall be under the terms and conditions of
144
+ this License, without any additional terms or conditions.
145
+ Notwithstanding the above, nothing herein shall supersede or modify
146
+ the terms of any separate license agreement you may have executed
147
+ with Licensor regarding such Contributions.
148
+
149
+ 6. Trademarks. This License does not grant permission to use the trade
150
+ names, trademarks, service marks, or product names of the Licensor,
151
+ except as required for reasonable and customary use in describing the
152
+ origin of the Work and reproducing the content of the NOTICE file.
153
+
154
+ 7. Disclaimer of Warranty. Unless required by applicable law or
155
+ agreed to in writing, Licensor provides the Work (and each
156
+ Contributor provides its Contributions) on an "AS IS" BASIS,
157
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
158
+ implied, including, without limitation, any warranties or conditions
159
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
160
+ PARTICULAR PURPOSE. You are solely responsible for determining the
161
+ appropriateness of using or redistributing the Work and assume any
162
+ risks associated with Your exercise of permissions under this License.
163
+
164
+ 8. Limitation of Liability. In no event and under no legal theory,
165
+ whether in tort (including negligence), contract, or otherwise,
166
+ unless required by applicable law (such as deliberate and grossly
167
+ negligent acts) or agreed to in writing, shall any Contributor be
168
+ liable to You for damages, including any direct, indirect, special,
169
+ incidental, or consequential damages of any character arising as a
170
+ result of this License or out of the use or inability to use the
171
+ Work (including but not limited to damages for loss of goodwill,
172
+ work stoppage, computer failure or malfunction, or any and all
173
+ other commercial damages or losses), even if such Contributor
174
+ has been advised of the possibility of such damages.
175
+
176
+ 9. Accepting Warranty or Additional Liability. While redistributing
177
+ the Work or Derivative Works thereof, You may choose to offer,
178
+ and charge a fee for, acceptance of support, warranty, indemnity,
179
+ or other liability obligations and/or rights consistent with this
180
+ License. However, in accepting such obligations, You may act only
181
+ on Your own behalf and on Your sole responsibility, not on behalf
182
+ of any other Contributor, and only if You agree to indemnify,
183
+ defend, and hold each Contributor harmless for any liability
184
+ incurred by, or claims asserted against, such Contributor by reason
185
+ of your accepting any such warranty or additional liability.
186
+
187
+ END OF TERMS AND CONDITIONS
188
+
189
+ APPENDIX: How to apply the Apache License to your work.
190
+
191
+ To apply the Apache License to your work, attach the following
192
+ boilerplate notice, with the fields enclosed by brackets "[]"
193
+ replaced with your own identifying information. (Don't include
194
+ the brackets!) The text should be enclosed in the appropriate
195
+ comment syntax for the file format. We also recommend that a
196
+ file or class name and description of purpose be included on the
197
+ same "printed page" as the copyright notice for easier
198
+ identification within third-party archives.
199
+
200
+ Copyright 2025 Nold AI (Owner: Dominikus Nold)
201
+
202
+ Licensed under the Apache License, Version 2.0 (the "License");
203
+ you may not use this file except in compliance with the License.
204
+ You may obtain a copy of the License at
205
+
206
+ http://www.apache.org/licenses/LICENSE-2.0
207
+
208
+ Unless required by applicable law or agreed to in writing, software
209
+ distributed under the License is distributed on an "AS IS" BASIS,
210
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
211
+ See the License for the specific language governing permissions and
212
+ limitations under the License.
213
+ License-File: LICENSE.md
214
+ Keywords: async,beartype,brownfield,cli,code-documentation,code-to-spec,contract-driven-development,contracts,crosshair,icontract,legacy-code,modernization,property-based-testing,quality-gates,refactoring,reverse-engineering,spec-first,specfact,state-machine,tdd,technical-debt
215
+ Classifier: Development Status :: 4 - Beta
216
+ Classifier: Intended Audience :: Developers
217
+ Classifier: License :: OSI Approved :: Apache Software License
218
+ Classifier: Programming Language :: Python :: 3
219
+ Classifier: Programming Language :: Python :: 3.11
220
+ Classifier: Programming Language :: Python :: 3.12
221
+ Classifier: Programming Language :: Python :: 3.13
222
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
223
+ Classifier: Topic :: Software Development :: Quality Assurance
224
+ Classifier: Topic :: Software Development :: Testing
225
+ Requires-Python: >=3.11
226
+ Requires-Dist: beartype>=0.22.4
227
+ Requires-Dist: crosshair-tool>=0.0.97
228
+ Requires-Dist: gitpython>=3.1.45
229
+ Requires-Dist: hypothesis>=6.142.4
230
+ Requires-Dist: icontract>=2.7.1
231
+ Requires-Dist: jinja2>=3.1.6
232
+ Requires-Dist: jsonschema>=4.23.0
233
+ Requires-Dist: networkx>=3.4.2
234
+ Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.27.0
235
+ Requires-Dist: opentelemetry-sdk>=1.27.0
236
+ Requires-Dist: pydantic>=2.12.3
237
+ Requires-Dist: python-dotenv>=1.2.1
238
+ Requires-Dist: pyyaml>=6.0.3
239
+ Requires-Dist: rich<14.0.0,>=13.0.0
240
+ Requires-Dist: ruamel-yaml>=0.18.16
241
+ Requires-Dist: ruff>=0.14.2
242
+ Requires-Dist: typer>=0.20.0
243
+ Requires-Dist: typing-extensions>=4.15.0
244
+ Requires-Dist: watchdog>=6.0.0
245
+ Provides-Extra: dev
246
+ Requires-Dist: basedpyright>=1.32.1; extra == 'dev'
247
+ Requires-Dist: beartype>=0.22.4; extra == 'dev'
248
+ Requires-Dist: crosshair-tool>=0.0.97; extra == 'dev'
249
+ Requires-Dist: hypothesis>=6.142.4; extra == 'dev'
250
+ Requires-Dist: icontract>=2.7.1; extra == 'dev'
251
+ Requires-Dist: isort>=7.0.0; extra == 'dev'
252
+ Requires-Dist: pip-tools>=7.5.1; extra == 'dev'
253
+ Requires-Dist: pylint>=4.0.2; extra == 'dev'
254
+ Requires-Dist: pytest-asyncio>=1.2.0; extra == 'dev'
255
+ Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
256
+ Requires-Dist: pytest-mock>=3.15.1; extra == 'dev'
257
+ Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
258
+ Requires-Dist: pytest>=8.4.2; extra == 'dev'
259
+ Requires-Dist: ruff>=0.14.2; extra == 'dev'
260
+ Requires-Dist: semgrep>=1.141.1; extra == 'dev'
261
+ Requires-Dist: tomlkit>=0.13.3; extra == 'dev'
262
+ Requires-Dist: types-pyyaml>=6.0.12.20250516; extra == 'dev'
263
+ Provides-Extra: scanning
264
+ Requires-Dist: semgrep>=1.141.1; extra == 'scanning'
265
+ Description-Content-Type: text/markdown
266
+
267
+ # SpecFact CLI
268
+
269
+ > **Understand and Modernize Legacy Code with Confidence**
270
+ > Automatically extract specs from existing Python code, then enforce them as contracts
271
+
272
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE.md)
273
+ [![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/)
274
+ [![Status](https://img.shields.io/badge/status-beta-orange.svg)](https://github.com/nold-ai/specfact-cli)
275
+
276
+ ---
277
+
278
+ ## What is SpecFact CLI?
279
+
280
+ A brownfield-first CLI that **reverse engineers your legacy code** into documented specs, then prevents regressions with runtime contract enforcement.
281
+
282
+ **Stop guessing what your legacy code does.** SpecFact automatically extracts specs from existing code, then enforces them as you modernize.
283
+
284
+ **Perfect for:** Teams modernizing legacy Python systems, data pipelines, DevOps scripts
285
+
286
+ **For teams that can't afford production bugs during migration.**
287
+
288
+ ---
289
+
290
+ ## Why SpecFact?
291
+
292
+ ### **Love GitHub Spec-Kit? SpecFact Adds What's Missing**
293
+
294
+ **Use both together:** Keep using Spec-Kit for new features, add SpecFact for legacy code modernization.
295
+
296
+ | What You Need | Spec-Kit | SpecFact CLI |
297
+ |---------------|----------|--------------|
298
+ | **Work with existing code** | ⚠️ Designed for new features | ✅ **Reverse-engineer legacy code** |
299
+ | **Prevent regressions** | ⚠️ Documentation only | ✅ **Runtime contract enforcement** |
300
+ | **Find hidden bugs** | ⚠️ LLM suggestions (may miss) | ✅ **Symbolic execution** (CrossHair) |
301
+ | **Automated safety net** | ⚠️ Manual code review | ✅ **CI/CD gates** (GitHub Actions) |
302
+
303
+ **Perfect together:**
304
+
305
+ - ✅ **Spec-Kit** for new features → Fast spec generation with Copilot
306
+ - ✅ **SpecFact** for legacy code → Runtime enforcement prevents regressions
307
+ - ✅ **Bidirectional sync** → Keep both tools in sync automatically
308
+ - ✅ **GitHub Actions** → SpecFact integrates with your existing GitHub workflows
309
+
310
+ **Bottom line:** Spec-Kit is great for documenting new features. SpecFact is essential for modernizing legacy code safely. Use both together for the best of both worlds.
311
+
312
+ ---
313
+
314
+ ## 💡 Key Capabilities
315
+
316
+ - ✅ **Reverse engineer legacy code** → Extract specs automatically from existing code
317
+ - ✅ **Runtime contract enforcement** → Prevent regressions during modernization
318
+ - ✅ **Symbolic execution** → Discover hidden edge cases with CrossHair
319
+ - ✅ **Works offline** → No cloud required, fully local
320
+
321
+ ---
322
+
323
+ ## Quick Start
324
+
325
+ ### Install in 10 seconds
326
+
327
+ ```bash
328
+ # Zero-install (just run it)
329
+ uvx --from specfact-cli specfact --help
330
+
331
+ # Or install with pip
332
+ pip install specfact-cli
333
+ ```
334
+
335
+ ### Your first command (< 60 seconds)
336
+
337
+ ```bash
338
+ # Modernizing legacy code? (Recommended)
339
+ specfact import from-code --repo . --name my-project
340
+
341
+ # Starting a new project?
342
+ specfact plan init --interactive
343
+
344
+ # Using GitHub Spec-Kit?
345
+ specfact import from-spec-kit --repo ./my-project --dry-run
346
+ ```
347
+
348
+ That's it! 🎉
349
+
350
+ ---
351
+
352
+ ## See It In Action
353
+
354
+ We ran SpecFact CLI **on itself** to prove it works:
355
+
356
+ - ⚡ Analyzed 32 Python files → Discovered **32 features** and **81 stories** in **3 seconds**
357
+ - 🚫 Set enforcement to "balanced" → **Blocked 2 HIGH violations** (as configured)
358
+ - 📊 Compared manual vs auto-derived plans → Found **24 deviations** in **5 seconds**
359
+
360
+ **Total time**: < 10 seconds | **Total value**: Found real naming inconsistencies and undocumented features
361
+
362
+ 👉 **[Read the complete example](docs/examples/dogfooding-specfact-cli.md)** with actual commands and outputs
363
+
364
+ ---
365
+
366
+ ## Documentation
367
+
368
+ **New to SpecFact?** Start with the [Getting Started Guide](docs/getting-started/README.md)
369
+
370
+ **Tried Spec-Kit?** See [How SpecFact Compares to Spec-Kit](docs/guides/speckit-comparison.md) and [The Journey: From Spec-Kit to SpecFact](docs/guides/speckit-journey.md)
371
+
372
+ **Need help?** Browse the [Documentation Hub](docs/README.md)
373
+
374
+ ---
375
+
376
+ ## Optional Telemetry (Opt-In)
377
+
378
+ - Telemetry is **off by default** and only activates if you set `SPECFACT_TELEMETRY_OPT_IN=true` or create `~/.specfact/telemetry.opt-in`.
379
+ - When enabled, SpecFact records anonymized metrics (e.g., number of features detected, contract violations blocked) to help us publish aggregate stats such as “contracts prevented 70% of the bugs surfaced during modernization.”
380
+ - Data is stored locally in `~/.specfact/telemetry.log`, and you can route it to your own OpenTelemetry collector via `SPECFACT_TELEMETRY_ENDPOINT`.
381
+ - Learn more in [`docs/reference/telemetry.md`](docs/reference/telemetry.md).
382
+
383
+ ---
384
+
385
+ ## Project Documentation
386
+
387
+ ### 📚 Online Documentation
388
+
389
+ **GitHub Pages**: Full documentation is available at `https://nold-ai.github.io/specfact-cli/`
390
+
391
+ The documentation includes:
392
+
393
+ - Getting Started guides
394
+ - Complete command reference
395
+ - IDE integration setup
396
+ - Use cases and examples
397
+ - Architecture overview
398
+ - Testing procedures
399
+
400
+ **Note**: The GitHub Pages workflow is configured and will automatically deploy when changes are pushed to the `main` branch. Enable GitHub Pages in your repository settings to activate the site.
401
+
402
+ ### 📖 Local Documentation
403
+
404
+ All documentation is in the [`docs/`](docs/) directory:
405
+
406
+ - **[Documentation Index](docs/README.md)** - Complete documentation overview
407
+ - **[Getting Started](docs/getting-started/installation.md)** - Installation and setup
408
+ - **[Command Reference](docs/reference/commands.md)** - All available commands
409
+ - **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands
410
+ - **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios
411
+
412
+ ---
413
+
414
+ ## Contributing
415
+
416
+ We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
417
+
418
+ ```bash
419
+ git clone https://github.com/nold-ai/specfact-cli.git
420
+ cd specfact-cli
421
+ pip install -e ".[dev]"
422
+ hatch run contract-test-full
423
+ ```
424
+
425
+ ---
426
+
427
+ ## License
428
+
429
+ **Apache License 2.0** - Open source and enterprise-friendly
430
+
431
+ SpecFact CLI is licensed under the Apache License 2.0, which means:
432
+
433
+ - ✅ **Free to use** for any purpose (commercial or non-commercial)
434
+ - ✅ **Modify and distribute** as needed
435
+ - ✅ **Enterprise-friendly** with explicit patent grant
436
+ - ✅ **Build commercial products** on top of SpecFact CLI
437
+
438
+ **Full license**: [LICENSE.md](LICENSE.md)
439
+
440
+ **Note**: The Apache 2.0 license is ideal for enterprise brownfield modernization projects, as it provides legal clarity and patent protection that many enterprises require.
441
+
442
+ ---
443
+
444
+ ## Support
445
+
446
+ - 💬 **Questions?** [GitHub Discussions](https://github.com/nold-ai/specfact-cli/discussions)
447
+ - 🐛 **Found a bug?** [GitHub Issues](https://github.com/nold-ai/specfact-cli/issues)
448
+ - 📧 **Need help?** [hello@noldai.com](mailto:hello@noldai.com)
449
+
450
+ ---
451
+
452
+ > **Built with ❤️ by [NOLD AI](https://noldai.com)**
453
+
454
+ Copyright © 2025 Nold AI (Owner: Dominikus Nold)
455
+
456
+ **Trademarks**: NOLD AI (NOLDAI) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All other trademarks mentioned in this project are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for more information.
@@ -0,0 +1,99 @@
1
+ specfact_cli/__init__.py,sha256=1iI2MYOrALPC6YlJP5YOyYLuoLeqtQEIt7GBJbb9O9E,338
2
+ specfact_cli/cli.py,sha256=VCPQKAYU0QP-nKWqXmObXtznpB4cRPQvj4FgVp2BGgI,13097
3
+ specfact_cli/telemetry.py,sha256=oLm1OcEzv0pqhjH2zEujt58jMhjk5jUdQDaPmNMEtus,16234
4
+ specfact_cli/agents/__init__.py,sha256=OsbbIhC5f3ojQLxgrB67NGeqNbtH8x_Nw41IFj8rgFE,662
5
+ specfact_cli/agents/analyze_agent.py,sha256=Ab9nHYkriXAcogdr2cmeiI6gYwb3bbITFIZaQBpKmuc,15866
6
+ specfact_cli/agents/base.py,sha256=fFS5R3_7U3hHvlTbXy1cren8Jx_p2ySEgjtY4tj5Jyc,3169
7
+ specfact_cli/agents/plan_agent.py,sha256=S1FdSAzLCTvZEVkASFKAONM6xskQc_HxNWJJQhqzfY8,6856
8
+ specfact_cli/agents/registry.py,sha256=kc7417QydGU9lhFEAKMSpoWwJsuYHFj1Q8cAYN4RItM,5161
9
+ specfact_cli/agents/sync_agent.py,sha256=AWp0k5AGaaKJvhpQ7rss3vCxG78hYRgskNU1LBfNABo,4351
10
+ specfact_cli/analyzers/__init__.py,sha256=p-fms9MQ_euOMklUXNBk_LH4htlWSWldkFvXF1jreMw,357
11
+ specfact_cli/analyzers/ambiguity_scanner.py,sha256=dqWtS7WD_fT7DkArrmw-fKi0gqTmekvA7oDYxal0pP0,26966
12
+ specfact_cli/analyzers/code_analyzer.py,sha256=4trA_h9mR0JLDsNx7ep1zEwTChrIg9V1MSvan3f0ihI,53124
13
+ specfact_cli/analyzers/constitution_evidence_extractor.py,sha256=dXxeSX7126wzfB6Ikq3gM2IUIPv-rSYThsxE3Ju4Vf8,20548
14
+ specfact_cli/analyzers/contract_extractor.py,sha256=sv6EsvhiE6tDmMNGp8haYaC6dL4KlifHqjzFelH9Bt4,16064
15
+ specfact_cli/analyzers/control_flow_analyzer.py,sha256=Q1eWxhRt9INz8qb8ztb7bVexGAjc3FKtOHBmphmbnlY,11545
16
+ specfact_cli/analyzers/requirement_extractor.py,sha256=FsqlTtqD0wUidu-NMkU-3-qA_86IpAvbLzYmROKSHmQ,11256
17
+ specfact_cli/analyzers/test_pattern_extractor.py,sha256=GdBQ7UKWch6ry67fAmHeZf2_1X9IDFT60RUMqapdhgU,13501
18
+ specfact_cli/commands/__init__.py,sha256=Hm0ddN9c3UUvXEH1hCj7lYpZEY7NS-8vnKCC0XEngVc,109
19
+ specfact_cli/commands/constitution.py,sha256=Buu0sbglUwGlTM-mNH9gwMCnxUXiFX_Sp7qKtFGn2gI,10980
20
+ specfact_cli/commands/enforce.py,sha256=dAQ-NTRZXEQ9d7b7ZEzPHbMp6p2Jy9aCI_GB6oKXJSU,3231
21
+ specfact_cli/commands/import_cmd.py,sha256=_Rl2ysw73JocB3kRLrke05jBQVpjwnEz7l8VSF88tHg,32258
22
+ specfact_cli/commands/init.py,sha256=FanigfWt5dxGwah5EnsIO2jQ8L7sMs1PDITP6Q7-je0,14955
23
+ specfact_cli/commands/plan.py,sha256=AkG3nSUdYtLfI-zdzBSCe5dvoHebGi84RbSdml2RReg,114173
24
+ specfact_cli/commands/repro.py,sha256=Xc6ugxODgk7u33doAIsz8rVc4SKmfhKfUvawHEnGptM,7384
25
+ specfact_cli/commands/sync.py,sha256=o4hr59cCOYLsWWYp_Z9GD1lssvinwKrndQHE02ZHHHU,45576
26
+ specfact_cli/common/__init__.py,sha256=0fSfsJVatzi2abkvUVpFsld3nPU8_EWGrphyCLHjqo0,778
27
+ specfact_cli/common/logger_setup.py,sha256=0d-0Ivjq7wrRZPvNizkExv1Qmm30x_LWDRWdP8CHt5M,26436
28
+ specfact_cli/common/logging_utils.py,sha256=wSDCasch5b4F7B5hRYd3oeWYzmz738eTX-BRP7WD8ko,1549
29
+ specfact_cli/common/text_utils.py,sha256=g9uNKyNeZAI54oPraMJH3KJcAIICpq66dNt2xtYXLfQ,1968
30
+ specfact_cli/common/utils.py,sha256=dB-4_-nqo6sY2-HyeyARDcpoMODA5pVKdIONxbd6PxI,1622
31
+ specfact_cli/comparators/__init__.py,sha256=DzVCDH6IKfCtvdyoeLWIMn8hlmgCwWmGq5aZMfTL8kY,280
32
+ specfact_cli/comparators/plan_comparator.py,sha256=TOPhIDDhA6z74xtSyAzd2Dg19N2qf6X_6AhweclyoEA,17532
33
+ specfact_cli/enrichers/constitution_enricher.py,sha256=YziG8LX_aA1MoLH7w-RIbBze2HilifnueYEtGh7ylW8,32827
34
+ specfact_cli/enrichers/plan_enricher.py,sha256=g-XwfYfIarDOLq-K7n3HTu5bIedkMlkkWtU4PpRG6qo,13366
35
+ specfact_cli/generators/__init__.py,sha256=VlKp49cOcREQQGCZ76PErSElLK_l54mEJ4WLr7ZsPQM,461
36
+ specfact_cli/generators/plan_generator.py,sha256=gjbYEQY5UFc71tXwl56KJSq1p_CkgmArbagCIellokQ,3878
37
+ specfact_cli/generators/protocol_generator.py,sha256=yOSmogp-bUwJ45AhqfKzAbKiJ9VzQsBnXlS8FloTbYo,4343
38
+ specfact_cli/generators/report_generator.py,sha256=oa6VBTWna_k6yl7oNsZSVSkveXIHc32l7Gy9OWj41Bs,8153
39
+ specfact_cli/generators/workflow_generator.py,sha256=NVC7XS1kAOH_NqtkU4FWcI3Ud7W40W2rPGYjAEhvBaU,4734
40
+ specfact_cli/importers/__init__.py,sha256=d7qKfshWR6grkPsKa8Qbwuq-zI820qPaVPvAeado7Gk,256
41
+ specfact_cli/importers/speckit_converter.py,sha256=J-lA7nMzv1awbgvoTeYIK7IDFVqarIIw3eVNb_WFFiI,48744
42
+ specfact_cli/importers/speckit_scanner.py,sha256=hUnWvgqBeAMp0UcxRNgE3HSzdPmNXV57FWNoy_p5X0c,34586
43
+ specfact_cli/models/__init__.py,sha256=Z8QJChgfvbFEWy04nexp0d7hQlu8YDriCEa5KfFeIz4,892
44
+ specfact_cli/models/deviation.py,sha256=C3JRu1CZqv1UIeMWhT2Rpk5xM8MW4RUGsKcd0AsE34w,3826
45
+ specfact_cli/models/enforcement.py,sha256=MFsxoleu9n2U1I7ng6GCIxkyj0M0gJ1v3dFi94sljDo,5720
46
+ specfact_cli/models/plan.py,sha256=OWIEruKT9FB8us_gtboofmV9h5SZY9PrDJG3TqOcx3o,6413
47
+ specfact_cli/models/protocol.py,sha256=s9SpUIH9qf0W0Io_wWEYjERTdf1VOowq6rj20I3p9To,900
48
+ specfact_cli/modes/__init__.py,sha256=sgER8YlbM4JO8erdd3OLkitQFHtfZrVqNMJMK6aOyhc,446
49
+ specfact_cli/modes/detector.py,sha256=qPs_KvlCXMQCnWP0vO6GGnmbgNFrrewYWlx5ffN9JJ4,3468
50
+ specfact_cli/modes/router.py,sha256=U9g4YhntRx7Wg6e59K1uMQt682YzzHdUeNHqEIfIUFU,5160
51
+ specfact_cli/resources/semgrep/async.yml,sha256=pz4xuPx7_CAEAwN-iq1zyc8srcid3GYtl7exsr1_5k8,8232
52
+ specfact_cli/sync/__init__.py,sha256=n2F1Jox_Wtu8D2zbtUkOQmAWVmvG324w278RhP0iy20,557
53
+ specfact_cli/sync/repository_sync.py,sha256=4jq0uUoWuHqFNd6g1OkVCUdTJuK9-WcsV8c8k2qFQkk,10007
54
+ specfact_cli/sync/speckit_sync.py,sha256=l_V7rYe7aLG6v3DPOJhPcc_1vx-jLqXAYsKZNLMbOzs,13612
55
+ specfact_cli/sync/watcher.py,sha256=7gnS2YT_rmxFseAPCjmrZ-kNlVZqMvD03deADZezzDk,8828
56
+ specfact_cli/utils/__init__.py,sha256=yq-D7yVQ9xxOwyFYFZjjCkLfGe1_dtZtOlIDK99BQC4,1358
57
+ specfact_cli/utils/acceptance_criteria.py,sha256=1N9dK-saSXyVFSp35dVIorHzPWaDiTG7_WMzn3Hwdkc,4553
58
+ specfact_cli/utils/console.py,sha256=6ihZ7geJy0DL0nfO-AALa8bkJXGtLxKZku-E9Dnl3ok,2255
59
+ specfact_cli/utils/enrichment_parser.py,sha256=yT5O1VvbG67ArMn4lSe7NbS6DtGI9mZOQNhMrMQLDOY,19330
60
+ specfact_cli/utils/feature_keys.py,sha256=SG0pd3uUw1mW8_tZNuNN86WrAY3nzSMRqtb7yyyRm4s,7241
61
+ specfact_cli/utils/git.py,sha256=qHmW50OaXccPCeCthMJZODHx5LibIJ1MuOOt95QS8Ao,7538
62
+ specfact_cli/utils/github_annotations.py,sha256=LrjO8QkXvjpyFNb5WoWR2vK9S19TASP1sveey-rHKys,15051
63
+ specfact_cli/utils/ide_setup.py,sha256=aPpbm1HlAhMfN4rwIFRavSSQNI6bm05J8yMPDKLul3g,19268
64
+ specfact_cli/utils/prompts.py,sha256=x2IdDLsTmZruUdOWg5KmVkRnZMg9KNLpW1_99KmIVIE,5762
65
+ specfact_cli/utils/structure.py,sha256=0T_SketbjnVbaKG263o9Ayu404h7yD_BEjsloidLuG0,26869
66
+ specfact_cli/utils/yaml_utils.py,sha256=-wzGctZjVwj2L0GhA6butUQWLMKaKPmNB6TCbtDMIhs,7277
67
+ specfact_cli/validators/__init__.py,sha256=89LYmr1wdgx6UGmV4qrf4M8WgxtHgaC8KCouzQBvRv8,500
68
+ specfact_cli/validators/fsm.py,sha256=pClGwSCa2JZjL-SfOvrCeO5LeFzlJg1GCO-BWHLUqos,9957
69
+ specfact_cli/validators/repro_checker.py,sha256=lafnbIepTCHmVm5LqaNtsE-G5Phr6L2hxJDmPbX3lDc,29445
70
+ specfact_cli/validators/schema.py,sha256=0FP_0qNpYd886-XtR1SwLlwD0Rw4_SzG-2fUTH3pcRA,7372
71
+ specfact_cli/resources/mappings/node-async.yaml,sha256=MCqFgUabY8hmO07lVTQwGtYAI1u1PwsjCWjJuuvunLM,1469
72
+ specfact_cli/resources/mappings/python-async.yaml,sha256=VdXTHoRBIJslrTrt3h3AH4q4EA_-EwrKXNstsA8BNic,1442
73
+ specfact_cli/resources/mappings/speckit-default.yaml,sha256=sM9hamOtgaJWKr_WJoWRbMUJf9Ci9bn3qtZ1zH65GIY,2432
74
+ specfact_cli/resources/prompts/specfact-enforce.md,sha256=dRP4uVDzZCRNAC8AL7srhBG43Q4JvkckC0ww7VF49kc,5702
75
+ specfact_cli/resources/prompts/specfact-import-from-code.md,sha256=7xrutJWepUN-OxCPAniTHpt5FCEIAFg01XG5XlaP2Oo,26844
76
+ specfact_cli/resources/prompts/specfact-plan-add-feature.md,sha256=IvEtZtEpVXA2kbcyc8PSt5wprSSR74Mcv6FlVDrUzME,6106
77
+ specfact_cli/resources/prompts/specfact-plan-add-story.md,sha256=5hSTslj97jrXIUOfLT2bkCjg25Wz95G_J3Qs7n5PMYU,6876
78
+ specfact_cli/resources/prompts/specfact-plan-compare.md,sha256=UVOLOy-9Jkbdzh7wDUt1EAgZr4v_BXHjNkpT8rEfdtk,19933
79
+ specfact_cli/resources/prompts/specfact-plan-init.md,sha256=mqHUdJ23VmLqFaqTG0f659QU4h8awt74eGNeVOxIdhU,19438
80
+ specfact_cli/resources/prompts/specfact-plan-promote.md,sha256=bSDs5pW7QRWvXLnGTlzkXJZ31-CbR16wP6VHx4_fGyk,13507
81
+ specfact_cli/resources/prompts/specfact-plan-review.md,sha256=C9JDeXbnFtW0Wz-v9O7EdyJHKrn5R5Cev5xPM4bwUTs,54562
82
+ specfact_cli/resources/prompts/specfact-plan-select.md,sha256=cuEgqNsx-VXosENN3j2ey4jFdxzINy-FFqO1V2H64-4,14398
83
+ specfact_cli/resources/prompts/specfact-plan-update-feature.md,sha256=iEheyaAaSeWDeGqm4tYliK56LfE_VqVEHcqdut7YlhM,8123
84
+ specfact_cli/resources/prompts/specfact-plan-update-idea.md,sha256=H3WtqQ2o6plHbUOZpR2G6s1sYAZRU7x90YiYi09n7Eg,6941
85
+ specfact_cli/resources/prompts/specfact-repro.md,sha256=TvKoxrAUrpOatBf3w1asrlS_nyxjRZsUTQZv17v-QI4,7650
86
+ specfact_cli/resources/prompts/specfact-sync.md,sha256=j7Bgpzc92pSWp9qBzJKRveNRTe5xQGSxc25qDIp0fLs,21966
87
+ specfact_cli/resources/schemas/deviation.schema.json,sha256=JqfPwBnAS-7uV0yD-E2U4BE042Cg0MYqOpAdqr9dXY8,1538
88
+ specfact_cli/resources/schemas/plan.schema.json,sha256=5IUsEZE-LNt45Ifg-sIlykg3TP7GUomNYVKfpI87o28,4685
89
+ specfact_cli/resources/schemas/protocol.schema.json,sha256=RSQ7TS_wc__C3CD1I1ZawjyH4bdqq-MoAZlpvjYUXbc,1238
90
+ specfact_cli/resources/templates/github-action.yml.j2,sha256=JxKcP9_SaJ_PvvFfYAJlqTFHljDeYJ0qVhPK3TvjWms,4461
91
+ specfact_cli/resources/templates/plan.bundle.yaml.j2,sha256=6QZQTXoBYZQvIa1boj-nQ2UqQIhrHSaLkmERVkLaIHw,3199
92
+ specfact_cli/resources/templates/pr-template.md.j2,sha256=w6iPRvfC96XnEoAQD_XN4B9C-LWSw_E582b0ZlDvw5Q,1121
93
+ specfact_cli/resources/templates/protocol.yaml.j2,sha256=lL3YccW_TdkxH1izaYnYDvGj0qKYsS40IdSrgdVLq1w,491
94
+ specfact_cli/resources/templates/telemetry.yaml.example,sha256=KZlB_tL1EBoByeVIVTQiVTXDWOnCvM_-3V-0Ew1mdwM,1728
95
+ specfact_cli-0.6.8.dist-info/METADATA,sha256=2OMhpRtpVJMeL44PYe56e36_NvbnGdQL4fLXbBXa51c,23259
96
+ specfact_cli-0.6.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
97
+ specfact_cli-0.6.8.dist-info/entry_points.txt,sha256=pwDD5Ttu6AF3p3T05M4G0aR2BELFyUu3214kjMRGEow,96
98
+ specfact_cli-0.6.8.dist-info/licenses/LICENSE.md,sha256=vXJAgzx3q10NHmRRcYZs03Mjs6adgXVx9TSOZHOHuxM,11453
99
+ specfact_cli-0.6.8.dist-info/RECORD,,
@@ -1,2 +1,3 @@
1
1
  [console_scripts]
2
2
  specfact = specfact_cli.cli:cli_main
3
+ specfact-cli = specfact_cli.cli:cli_main