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,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (which shall not include Communications that are clearly marked or
39
+ otherwise designated in writing by the copyright owner as "Not a Work").
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is clearly marked or otherwise designated
61
+ in writing by the copyright owner as "Not a Contribution".
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2025 Nold AI (Owner: Dominikus Nold)
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -1,370 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: specfact-cli
3
- Version: 0.4.2
4
- Summary: SpecFact CLI - Spec→Contract→Sentinel tool for contract-driven development with automated quality gates
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: # Sustainable Use License
12
-
13
- Version 1.0
14
-
15
- ## Acceptance
16
-
17
- By using the software, you agree to all of the terms and conditions below.
18
-
19
- ## Copyright License
20
-
21
- The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations below.
22
-
23
- ## Limitations
24
-
25
- You may use or modify the software only for your own internal business purposes or for non-commercial or personal use. You may distribute the software or provide it to others only if you do so free of charge for non-commercial purposes. You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software.
26
-
27
- ## Trademarks
28
-
29
- **NOLD AI** (also referred to as **NOLDAI**) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All rights to the NOLD AI trademark are reserved.
30
-
31
- Any use of the licensor's trademarks is subject to applicable law. All other trademarks, service marks, and trade names mentioned in this software are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for a complete list of third-party trademarks and their respective owners.
32
-
33
- ## Patents
34
-
35
- The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
36
-
37
- ## Notices
38
-
39
- You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. If you modify the software, you must include in any modified copies of the software a prominent notice stating that you have modified the software.
40
-
41
- ## No Other Rights
42
-
43
- These terms do not imply any licenses other than those expressly granted in these terms.
44
-
45
- ## Termination
46
-
47
- If you use the software in violation of these terms, such use is not licensed, and your license will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your license will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your license to terminate automatically and permanently.
48
-
49
- ## No Liability
50
-
51
- As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
52
-
53
- ## Definitions
54
-
55
- The "licensor" is Nold AI (Owner: Dominikus Nold).
56
-
57
- The "software" is the SpecFact CLI software the licensor makes available under these terms, including any portion of it.
58
-
59
- "You" refers to the individual or entity agreeing to these terms.
60
-
61
- "Your company" is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
62
-
63
- "Your license" is the license granted to you for the software under these terms.
64
-
65
- "Use" means anything you do with the software requiring your license.
66
-
67
- "Trademark" means trademarks, service marks, and similar rights.
68
-
69
- ---
70
-
71
- Copyright (c) 2025 Nold AI (Owner: Dominikus Nold)
72
- License-File: LICENSE.md
73
- Keywords: async,beartype,cli,contract-driven-development,contracts,crosshair,icontract,property-based-testing,quality-gates,spec-first,specfact,state-machine,tdd
74
- Classifier: Development Status :: 4 - Beta
75
- Classifier: Intended Audience :: Developers
76
- Classifier: License :: Other/Proprietary License
77
- Classifier: Programming Language :: Python :: 3
78
- Classifier: Programming Language :: Python :: 3.11
79
- Classifier: Programming Language :: Python :: 3.12
80
- Classifier: Programming Language :: Python :: 3.13
81
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
82
- Classifier: Topic :: Software Development :: Quality Assurance
83
- Classifier: Topic :: Software Development :: Testing
84
- Requires-Python: >=3.11
85
- Requires-Dist: beartype>=0.22.4
86
- Requires-Dist: crosshair-tool>=0.0.97
87
- Requires-Dist: gitpython>=3.1.45
88
- Requires-Dist: hypothesis>=6.142.4
89
- Requires-Dist: icontract>=2.7.1
90
- Requires-Dist: jinja2>=3.1.6
91
- Requires-Dist: jsonschema>=4.23.0
92
- Requires-Dist: networkx>=3.4.2
93
- Requires-Dist: pydantic>=2.12.3
94
- Requires-Dist: python-dotenv>=1.2.1
95
- Requires-Dist: pyyaml>=6.0.3
96
- Requires-Dist: rich<14.0.0,>=13.0.0
97
- Requires-Dist: ruamel-yaml>=0.18.16
98
- Requires-Dist: ruff>=0.14.2
99
- Requires-Dist: typer>=0.20.0
100
- Requires-Dist: typing-extensions>=4.15.0
101
- Provides-Extra: dev
102
- Requires-Dist: basedpyright>=1.32.1; extra == 'dev'
103
- Requires-Dist: beartype>=0.22.4; extra == 'dev'
104
- Requires-Dist: black>=25.9.0; extra == 'dev'
105
- Requires-Dist: crosshair-tool>=0.0.97; extra == 'dev'
106
- Requires-Dist: hypothesis>=6.142.4; extra == 'dev'
107
- Requires-Dist: icontract>=2.7.1; extra == 'dev'
108
- Requires-Dist: isort>=7.0.0; extra == 'dev'
109
- Requires-Dist: pip-tools>=7.5.1; extra == 'dev'
110
- Requires-Dist: pylint>=4.0.2; extra == 'dev'
111
- Requires-Dist: pytest-asyncio>=1.2.0; extra == 'dev'
112
- Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
113
- Requires-Dist: pytest-mock>=3.15.1; extra == 'dev'
114
- Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
115
- Requires-Dist: pytest>=8.4.2; extra == 'dev'
116
- Requires-Dist: ruff>=0.14.2; extra == 'dev'
117
- Requires-Dist: semgrep>=1.141.1; extra == 'dev'
118
- Requires-Dist: tomlkit>=0.13.3; extra == 'dev'
119
- Requires-Dist: types-pyyaml>=6.0.12.20250516; extra == 'dev'
120
- Provides-Extra: scanning
121
- Requires-Dist: semgrep>=1.141.1; extra == 'scanning'
122
- Description-Content-Type: text/markdown
123
-
124
- # SpecFact CLI
125
-
126
- > **Stop "vibe coding", start shipping quality code with contracts**
127
-
128
- [![License](https://img.shields.io/badge/license-Sustainable%20Use-blue.svg)](LICENSE.md)
129
- [![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/)
130
- [![Status](https://img.shields.io/badge/status-beta-orange.svg)](https://github.com/nold-ai/specfact-cli)
131
-
132
- ---
133
-
134
- ## What is SpecFact CLI?
135
-
136
- A command-line tool that helps you write better code by enforcing **contracts** - rules that catch bugs before they reach production.
137
-
138
- Think of it as a **quality gate** for your development workflow that:
139
-
140
- - ✅ Catches async bugs automatically
141
- - ✅ Validates your code matches your specs
142
- - ✅ Blocks bad code from merging
143
- - ✅ Works offline, no cloud required
144
-
145
- **Perfect for:** Teams who want to ship faster without breaking things.
146
-
147
- ---
148
-
149
- ## Quick Start
150
-
151
- ### Install in 10 seconds
152
-
153
- ```bash
154
- # Zero-install (just run it)
155
- uvx --from specfact-cli specfact --help
156
-
157
- # Or install with pip
158
- pip install specfact-cli
159
- ```
160
-
161
- ### Your first command (< 60 seconds)
162
-
163
- ```bash
164
- # Starting a new project?
165
- specfact plan init --interactive
166
-
167
- # Have existing code?
168
- specfact import from-code --repo . --name my-project
169
-
170
- # Using GitHub Spec-Kit?
171
- specfact import from-spec-kit --repo ./my-project --dry-run
172
- ```
173
-
174
- That's it! 🎉
175
-
176
- ---
177
-
178
- ## See It In Action
179
-
180
- We ran SpecFact CLI **on itself** to prove it works:
181
-
182
- - ⚡ Analyzed 32 Python files → Discovered **32 features** and **81 stories** in **3 seconds**
183
- - 🚫 Set enforcement to "balanced" → **Blocked 2 HIGH violations** (as configured)
184
- - 📊 Compared manual vs auto-derived plans → Found **24 deviations** in **5 seconds**
185
-
186
- **Total time**: < 10 seconds | **Total value**: Found real naming inconsistencies and undocumented features
187
-
188
- 👉 **[Read the complete example](docs/examples/dogfooding-specfact-cli.md)** with actual commands and outputs
189
-
190
- ---
191
-
192
- ## What Can You Do?
193
-
194
- ### 1. 🔄 Import from GitHub Spec-Kit
195
-
196
- Already using Spec-Kit? **Level up to automated enforcement** in one command:
197
-
198
- ```bash
199
- specfact import from-spec-kit --repo ./spec-kit-project --write
200
- ```
201
-
202
- **Result**: Your Spec-Kit artifacts become production-ready contracts with automated quality gates.
203
-
204
- ### 2. 🔍 Analyze Your Existing Code
205
-
206
- Turn brownfield code into a clean spec:
207
-
208
- ```bash
209
- specfact import from-code --repo . --name my-project
210
- ```
211
-
212
- **Result**: Auto-generated plan showing what your code actually does
213
-
214
- ### 3. 📋 Plan New Features
215
-
216
- Start with a spec, not with code:
217
-
218
- ```bash
219
- specfact plan init --interactive
220
- specfact plan add-feature --key FEATURE-001 --title "User Login"
221
- ```
222
-
223
- **Result**: Clear acceptance criteria before writing any code
224
-
225
- ### 4. 🛡️ Enforce Quality
226
-
227
- Set rules that actually block bad code:
228
-
229
- ```bash
230
- specfact enforce stage --preset balanced
231
- ```
232
-
233
- **Modes:**
234
-
235
- - `minimal` - Just observe, never block
236
- - `balanced` - Block critical bugs, warn on others
237
- - `strict` - Block everything suspicious
238
-
239
- ### 5. ✅ Validate Everything
240
-
241
- One command to check it all:
242
-
243
- ```bash
244
- specfact repro
245
- ```
246
-
247
- **Checks:** Contracts, types, async patterns, state machines
248
-
249
- ---
250
-
251
- ## Documentation
252
-
253
- For complete documentation, see **[docs/README.md](docs/README.md)**.
254
-
255
- **Quick Links:**
256
-
257
- - 📖 **[Getting Started](docs/getting-started/README.md)** - Installation and first steps
258
- - 🎯 **[The Journey: From Spec-Kit to SpecFact](docs/guides/speckit-journey.md)** - Level up from interactive authoring to automated enforcement
259
- - 📋 **[Command Reference](docs/reference/commands.md)** - All commands with examples
260
- - 🤖 **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands in your IDE
261
- - 💡 **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios
262
-
263
- ---
264
-
265
- ## Installation Options
266
-
267
- ### 1. uvx (Easiest)
268
-
269
- No installation needed:
270
-
271
- ```bash
272
- uvx --from specfact-cli specfact plan init
273
- ```
274
-
275
- ### 2. pip
276
-
277
- Install globally:
278
-
279
- ```bash
280
- pip install specfact-cli
281
- specfact --help
282
- ```
283
-
284
- ### 3. Docker
285
-
286
- Run in a container:
287
-
288
- ```bash
289
- docker run ghcr.io/nold-ai/specfact-cli:latest --help
290
- ```
291
-
292
- ---
293
-
294
- ## Project Documentation
295
-
296
- ### 📚 Online Documentation
297
-
298
- **GitHub Pages**: Full documentation is available at `https://nold-ai.github.io/specfact-cli/`
299
-
300
- The documentation includes:
301
-
302
- - Getting Started guides
303
- - Complete command reference
304
- - IDE integration setup
305
- - Use cases and examples
306
- - Architecture overview
307
- - Testing procedures
308
-
309
- **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.
310
-
311
- ### 📖 Local Documentation
312
-
313
- All documentation is in the [`docs/`](docs/) directory:
314
-
315
- - **[Documentation Index](docs/README.md)** - Complete documentation overview
316
- - **[Getting Started](docs/getting-started/installation.md)** - Installation and setup
317
- - **[Command Reference](docs/reference/commands.md)** - All available commands
318
- - **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands
319
- - **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios
320
-
321
- ---
322
-
323
- ## Contributing
324
-
325
- We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
326
-
327
- ```bash
328
- git clone https://github.com/nold-ai/specfact-cli.git
329
- cd specfact-cli
330
- pip install -e ".[dev]"
331
- hatch run contract-test-full
332
- ```
333
-
334
- ---
335
-
336
- ## License
337
-
338
- **Sustainable Use License** - Free for internal business use
339
-
340
- ### ✅ You Can
341
-
342
- - Use it for your business (internal tools, automation)
343
- - Modify it for your own needs
344
- - Provide consulting services using SpecFact CLI
345
-
346
- ### ❌ You Cannot
347
-
348
- - Sell it as a SaaS product
349
- - White-label and resell
350
- - Create competing products
351
-
352
- For commercial licensing, contact [hello@noldai.com](mailto:hello@noldai.com)
353
-
354
- **Full license**: [LICENSE.md](LICENSE.md) | **FAQ**: [USAGE-FAQ.md](USAGE-FAQ.md)
355
-
356
- ---
357
-
358
- ## Support
359
-
360
- - 💬 **Questions?** [GitHub Discussions](https://github.com/nold-ai/specfact-cli/discussions)
361
- - 🐛 **Found a bug?** [GitHub Issues](https://github.com/nold-ai/specfact-cli/issues)
362
- - 📧 **Need help?** [hello@noldai.com](mailto:hello@noldai.com)
363
-
364
- ---
365
-
366
- > **Built with ❤️ by [NOLD AI](https://noldai.com)**
367
-
368
- Copyright © 2025 Nold AI (Owner: Dominikus Nold)
369
-
370
- **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.
@@ -1,62 +0,0 @@
1
- specfact_cli/__init__.py,sha256=ky_0Qq5fBOOCHadFQkn8Eh8S63DLp5-vF3yq8GKcoM0,338
2
- specfact_cli/cli.py,sha256=UVAajgoE337KggXSBsvje_4mEeM1ef-D_d1yq3h1Mqg,14511
3
- specfact_cli/agents/__init__.py,sha256=OsbbIhC5f3ojQLxgrB67NGeqNbtH8x_Nw41IFj8rgFE,662
4
- specfact_cli/agents/analyze_agent.py,sha256=nbHRaPEGJdQa7kGt4sG-ebPmgo1NT9wnPqi6Ql37wp4,15855
5
- specfact_cli/agents/base.py,sha256=fFS5R3_7U3hHvlTbXy1cren8Jx_p2ySEgjtY4tj5Jyc,3169
6
- specfact_cli/agents/plan_agent.py,sha256=S1FdSAzLCTvZEVkASFKAONM6xskQc_HxNWJJQhqzfY8,6856
7
- specfact_cli/agents/registry.py,sha256=kc7417QydGU9lhFEAKMSpoWwJsuYHFj1Q8cAYN4RItM,5161
8
- specfact_cli/agents/sync_agent.py,sha256=AWp0k5AGaaKJvhpQ7rss3vCxG78hYRgskNU1LBfNABo,4351
9
- specfact_cli/analyzers/__init__.py,sha256=SgSPrXjmrdGqvmCmScRObEIcJi2NXEciNX9SF2YeT8w,267
10
- specfact_cli/analyzers/code_analyzer.py,sha256=c7emnYKiG1sMdSazApbJT7OdaSj-u2tD2WsBFk2EN3s,32700
11
- specfact_cli/commands/__init__.py,sha256=Hm0ddN9c3UUvXEH1hCj7lYpZEY7NS-8vnKCC0XEngVc,109
12
- specfact_cli/commands/enforce.py,sha256=uYUeVXw-U5bLG0uss9ZtCyNeJY0Dz672UUgqS7di6Gs,2834
13
- specfact_cli/commands/import_cmd.py,sha256=h1Wry4uYSvRWpdi7qNU14VwLsoS2gumahGSVJYCAOec,14144
14
- specfact_cli/commands/init.py,sha256=ou8RwRFbh-UT4TjfXvJ8bA9dZX9uJS5JOpyJ080mrzY,4701
15
- specfact_cli/commands/plan.py,sha256=1nE_EP640FWhfMcgKpF__80Bo-nFkpVOec4nnwwHPLo,41053
16
- specfact_cli/commands/repro.py,sha256=nd0MCEdc33gLZKfF5QlJuTjY6ydvHE_y7xEFKLxzVs4,6430
17
- specfact_cli/commands/sync.py,sha256=V_zi9DUStgoGX7HWVWV_bP8CEebpAEMLO2N_7sx59i8,17142
18
- specfact_cli/common/__init__.py,sha256=0fSfsJVatzi2abkvUVpFsld3nPU8_EWGrphyCLHjqo0,778
19
- specfact_cli/common/logger_setup.py,sha256=0d-0Ivjq7wrRZPvNizkExv1Qmm30x_LWDRWdP8CHt5M,26436
20
- specfact_cli/common/logging_utils.py,sha256=wSDCasch5b4F7B5hRYd3oeWYzmz738eTX-BRP7WD8ko,1549
21
- specfact_cli/common/text_utils.py,sha256=g9uNKyNeZAI54oPraMJH3KJcAIICpq66dNt2xtYXLfQ,1968
22
- specfact_cli/common/utils.py,sha256=dB-4_-nqo6sY2-HyeyARDcpoMODA5pVKdIONxbd6PxI,1622
23
- specfact_cli/comparators/__init__.py,sha256=DzVCDH6IKfCtvdyoeLWIMn8hlmgCwWmGq5aZMfTL8kY,280
24
- specfact_cli/comparators/plan_comparator.py,sha256=TOPhIDDhA6z74xtSyAzd2Dg19N2qf6X_6AhweclyoEA,17532
25
- specfact_cli/generators/__init__.py,sha256=VlKp49cOcREQQGCZ76PErSElLK_l54mEJ4WLr7ZsPQM,461
26
- specfact_cli/generators/plan_generator.py,sha256=gjbYEQY5UFc71tXwl56KJSq1p_CkgmArbagCIellokQ,3878
27
- specfact_cli/generators/protocol_generator.py,sha256=yOSmogp-bUwJ45AhqfKzAbKiJ9VzQsBnXlS8FloTbYo,4343
28
- specfact_cli/generators/report_generator.py,sha256=oa6VBTWna_k6yl7oNsZSVSkveXIHc32l7Gy9OWj41Bs,8153
29
- specfact_cli/generators/workflow_generator.py,sha256=NVC7XS1kAOH_NqtkU4FWcI3Ud7W40W2rPGYjAEhvBaU,4734
30
- specfact_cli/importers/__init__.py,sha256=d7qKfshWR6grkPsKa8Qbwuq-zI820qPaVPvAeado7Gk,256
31
- specfact_cli/importers/speckit_converter.py,sha256=ftJ729wJbi7KWSRz72L0_tyohr2-2yh0VewUuuPADxs,32093
32
- specfact_cli/importers/speckit_scanner.py,sha256=SsaCqt4l4lLf00R1O3xHYcG7-m0duzjnAXoFlGCacxI,31548
33
- specfact_cli/models/__init__.py,sha256=Z8QJChgfvbFEWy04nexp0d7hQlu8YDriCEa5KfFeIz4,892
34
- specfact_cli/models/deviation.py,sha256=C3JRu1CZqv1UIeMWhT2Rpk5xM8MW4RUGsKcd0AsE34w,3826
35
- specfact_cli/models/enforcement.py,sha256=MFsxoleu9n2U1I7ng6GCIxkyj0M0gJ1v3dFi94sljDo,5720
36
- specfact_cli/models/plan.py,sha256=Fr_w49R6zM-E7rsEke1uMj3amwF_luJbm_Xk9MFi7V0,4413
37
- specfact_cli/models/protocol.py,sha256=s9SpUIH9qf0W0Io_wWEYjERTdf1VOowq6rj20I3p9To,900
38
- specfact_cli/modes/__init__.py,sha256=sgER8YlbM4JO8erdd3OLkitQFHtfZrVqNMJMK6aOyhc,446
39
- specfact_cli/modes/detector.py,sha256=qPs_KvlCXMQCnWP0vO6GGnmbgNFrrewYWlx5ffN9JJ4,3468
40
- specfact_cli/modes/router.py,sha256=U9g4YhntRx7Wg6e59K1uMQt682YzzHdUeNHqEIfIUFU,5160
41
- specfact_cli/resources/semgrep/async.yml,sha256=pz4xuPx7_CAEAwN-iq1zyc8srcid3GYtl7exsr1_5k8,8232
42
- specfact_cli/sync/__init__.py,sha256=usRwUvL2q01J0tfLSJ6bLw8ADPJBNBFGQgIK6iu6CuU,397
43
- specfact_cli/sync/repository_sync.py,sha256=4jq0uUoWuHqFNd6g1OkVCUdTJuK9-WcsV8c8k2qFQkk,10007
44
- specfact_cli/sync/speckit_sync.py,sha256=l_V7rYe7aLG6v3DPOJhPcc_1vx-jLqXAYsKZNLMbOzs,13612
45
- specfact_cli/utils/__init__.py,sha256=yq-D7yVQ9xxOwyFYFZjjCkLfGe1_dtZtOlIDK99BQC4,1358
46
- specfact_cli/utils/console.py,sha256=6ihZ7geJy0DL0nfO-AALa8bkJXGtLxKZku-E9Dnl3ok,2255
47
- specfact_cli/utils/feature_keys.py,sha256=cb6JPGx8d9KRuRDBK2ejih1PKm1pWrmLmlfSu8NhPP8,6667
48
- specfact_cli/utils/git.py,sha256=qHmW50OaXccPCeCthMJZODHx5LibIJ1MuOOt95QS8Ao,7538
49
- specfact_cli/utils/github_annotations.py,sha256=LrjO8QkXvjpyFNb5WoWR2vK9S19TASP1sveey-rHKys,15051
50
- specfact_cli/utils/ide_setup.py,sha256=BcBxi_HGVmiqy3TH-IcEymWUoN1_OY_9Cvl7YZ_mFG0,12365
51
- specfact_cli/utils/prompts.py,sha256=x2IdDLsTmZruUdOWg5KmVkRnZMg9KNLpW1_99KmIVIE,5762
52
- specfact_cli/utils/structure.py,sha256=iOzKw9_dBGPmY8hODJJKpl5pLb52R7xYmsBMsapM-ms,18399
53
- specfact_cli/utils/yaml_utils.py,sha256=xK2uvCVUssaHnB4BLYq9vJUarSuIIxANftlq8yrltkA,5719
54
- specfact_cli/validators/__init__.py,sha256=89LYmr1wdgx6UGmV4qrf4M8WgxtHgaC8KCouzQBvRv8,500
55
- specfact_cli/validators/fsm.py,sha256=pClGwSCa2JZjL-SfOvrCeO5LeFzlJg1GCO-BWHLUqos,9957
56
- specfact_cli/validators/repro_checker.py,sha256=AtUm6kMPtR3iO8lhVa4nVt5UbYxylfGOskbINGfcIyk,28305
57
- specfact_cli/validators/schema.py,sha256=bptpfOT2cRvu4nY6L6xAcFd8qzsnMB4Ab8b7OwENTGo,6711
58
- specfact_cli-0.4.2.dist-info/METADATA,sha256=JcllFf96dW3sh0VvD_4-gkiCIc-cM88JOe7AZBftDKg,13939
59
- specfact_cli-0.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
60
- specfact_cli-0.4.2.dist-info/entry_points.txt,sha256=NvpypgoclYhHooSFA3rOeoqoyo9hkM547yMbujJbjOk,55
61
- specfact_cli-0.4.2.dist-info/licenses/LICENSE.md,sha256=tChK3RXRg_muIzhv8ezn4PYnmO1ldkiNyTRV_ih6YmM,4113
62
- specfact_cli-0.4.2.dist-info/RECORD,,