specsmith 0.1.0a4__tar.gz
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.
- specsmith-0.1.0a4/LICENSE +21 -0
- specsmith-0.1.0a4/PKG-INFO +232 -0
- specsmith-0.1.0a4/README.md +191 -0
- specsmith-0.1.0a4/pyproject.toml +80 -0
- specsmith-0.1.0a4/setup.cfg +4 -0
- specsmith-0.1.0a4/src/specsmith/__init__.py +5 -0
- specsmith-0.1.0a4/src/specsmith/__main__.py +7 -0
- specsmith-0.1.0a4/src/specsmith/auditor.py +470 -0
- specsmith-0.1.0a4/src/specsmith/cli.py +556 -0
- specsmith-0.1.0a4/src/specsmith/commands/__init__.py +3 -0
- specsmith-0.1.0a4/src/specsmith/compressor.py +152 -0
- specsmith-0.1.0a4/src/specsmith/config.py +269 -0
- specsmith-0.1.0a4/src/specsmith/differ.py +81 -0
- specsmith-0.1.0a4/src/specsmith/exporter.py +117 -0
- specsmith-0.1.0a4/src/specsmith/importer.py +486 -0
- specsmith-0.1.0a4/src/specsmith/integrations/__init__.py +53 -0
- specsmith-0.1.0a4/src/specsmith/integrations/aider.py +38 -0
- specsmith-0.1.0a4/src/specsmith/integrations/base.py +31 -0
- specsmith-0.1.0a4/src/specsmith/integrations/claude_code.py +58 -0
- specsmith-0.1.0a4/src/specsmith/integrations/copilot.py +55 -0
- specsmith-0.1.0a4/src/specsmith/integrations/cursor.py +62 -0
- specsmith-0.1.0a4/src/specsmith/integrations/gemini.py +49 -0
- specsmith-0.1.0a4/src/specsmith/integrations/warp.py +70 -0
- specsmith-0.1.0a4/src/specsmith/integrations/windsurf.py +46 -0
- specsmith-0.1.0a4/src/specsmith/scaffolder.py +372 -0
- specsmith-0.1.0a4/src/specsmith/templates/agents.md.j2 +159 -0
- specsmith-0.1.0a4/src/specsmith/templates/docs/architecture.md.j2 +39 -0
- specsmith-0.1.0a4/src/specsmith/templates/docs/requirements.md.j2 +130 -0
- specsmith-0.1.0a4/src/specsmith/templates/docs/test-spec.md.j2 +42 -0
- specsmith-0.1.0a4/src/specsmith/templates/docs/workflow.md.j2 +15 -0
- specsmith-0.1.0a4/src/specsmith/templates/gitattributes.j2 +15 -0
- specsmith-0.1.0a4/src/specsmith/templates/gitignore.j2 +38 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/context-budget.md.j2 +50 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/drift-metrics.md.j2 +54 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/roles.md.j2 +30 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/rules.md.j2 +49 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/verification.md.j2 +59 -0
- specsmith-0.1.0a4/src/specsmith/templates/governance/workflow.md.j2 +80 -0
- specsmith-0.1.0a4/src/specsmith/templates/ledger.md.j2 +27 -0
- specsmith-0.1.0a4/src/specsmith/templates/pyproject.toml.j2 +18 -0
- specsmith-0.1.0a4/src/specsmith/templates/python/cli.py.j2 +13 -0
- specsmith-0.1.0a4/src/specsmith/templates/python/init.py.j2 +3 -0
- specsmith-0.1.0a4/src/specsmith/templates/readme.md.j2 +30 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/exec.cmd.j2 +33 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/exec.sh.j2 +38 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/run.cmd.j2 +14 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/run.sh.j2 +7 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/setup.cmd.j2 +23 -0
- specsmith-0.1.0a4/src/specsmith/templates/scripts/setup.sh.j2 +12 -0
- specsmith-0.1.0a4/src/specsmith/tools.py +410 -0
- specsmith-0.1.0a4/src/specsmith/upgrader.py +118 -0
- specsmith-0.1.0a4/src/specsmith/validator.py +218 -0
- specsmith-0.1.0a4/src/specsmith/vcs/__init__.py +41 -0
- specsmith-0.1.0a4/src/specsmith/vcs/base.py +122 -0
- specsmith-0.1.0a4/src/specsmith/vcs/bitbucket.py +135 -0
- specsmith-0.1.0a4/src/specsmith/vcs/github.py +261 -0
- specsmith-0.1.0a4/src/specsmith/vcs/gitlab.py +142 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/PKG-INFO +232 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/SOURCES.txt +71 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/dependency_links.txt +1 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/entry_points.txt +2 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/requires.txt +17 -0
- specsmith-0.1.0a4/src/specsmith.egg-info/top_level.txt +1 -0
- specsmith-0.1.0a4/tests/test_auditor.py +81 -0
- specsmith-0.1.0a4/tests/test_cli.py +119 -0
- specsmith-0.1.0a4/tests/test_compressor.py +51 -0
- specsmith-0.1.0a4/tests/test_importer.py +185 -0
- specsmith-0.1.0a4/tests/test_integrations.py +85 -0
- specsmith-0.1.0a4/tests/test_scaffolder.py +139 -0
- specsmith-0.1.0a4/tests/test_smoke.py +33 -0
- specsmith-0.1.0a4/tests/test_tools.py +153 -0
- specsmith-0.1.0a4/tests/test_validator.py +62 -0
- specsmith-0.1.0a4/tests/test_vcs.py +201 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 BitConcepts, LLC.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: specsmith
|
|
3
|
+
Version: 0.1.0a4
|
|
4
|
+
Summary: Forge governed project scaffolds from the Agentic AI Development Workflow Specification.
|
|
5
|
+
Author: BitConcepts
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/BitConcepts/specsmith
|
|
8
|
+
Project-URL: Repository, https://github.com/BitConcepts/specsmith
|
|
9
|
+
Project-URL: Changelog, https://github.com/BitConcepts/specsmith/blob/main/CHANGELOG.md
|
|
10
|
+
Keywords: agentic,scaffold,governance,agents-md,cli,specification
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Topic :: Software Development :: Code Generators
|
|
21
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
Requires-Dist: click>=8.1
|
|
26
|
+
Requires-Dist: jinja2>=3.1
|
|
27
|
+
Requires-Dist: pyyaml>=6.0
|
|
28
|
+
Requires-Dist: pydantic>=2.0
|
|
29
|
+
Requires-Dist: rich>=13.0
|
|
30
|
+
Provides-Extra: dev
|
|
31
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
32
|
+
Requires-Dist: pytest-cov>=4.0; extra == "dev"
|
|
33
|
+
Requires-Dist: ruff>=0.4; extra == "dev"
|
|
34
|
+
Requires-Dist: mypy>=1.10; extra == "dev"
|
|
35
|
+
Requires-Dist: pre-commit>=3.0; extra == "dev"
|
|
36
|
+
Requires-Dist: types-pyyaml>=6.0; extra == "dev"
|
|
37
|
+
Provides-Extra: docs
|
|
38
|
+
Requires-Dist: mkdocs>=1.6; extra == "docs"
|
|
39
|
+
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
|
|
40
|
+
Dynamic: license-file
|
|
41
|
+
|
|
42
|
+
# specsmith
|
|
43
|
+
|
|
44
|
+
[](https://github.com/BitConcepts/specsmith/actions/workflows/ci.yml)
|
|
45
|
+
[](https://specsmith.readthedocs.io/en/latest/)
|
|
46
|
+
[](https://www.python.org/downloads/)
|
|
47
|
+
[](LICENSE)
|
|
48
|
+
|
|
49
|
+
Forge governed project scaffolds from the Agentic AI Development Workflow Specification.
|
|
50
|
+
|
|
51
|
+
> Intelligence proposes. Constraints decide. The ledger remembers.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## What is specsmith?
|
|
56
|
+
|
|
57
|
+
`specsmith` is a CLI tool that generates full project scaffolds with built-in AI agent governance. It creates the file structure, CI/CD pipelines, governance documents, and agent integration files that AI coding assistants need to work within a structured, auditable workflow.
|
|
58
|
+
|
|
59
|
+
Every scaffolded project follows the closed-loop workflow: **propose → check → execute → verify → record**.
|
|
60
|
+
|
|
61
|
+
## Install
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pip install specsmith
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
From source:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
git clone https://github.com/BitConcepts/specsmith.git
|
|
71
|
+
cd specsmith
|
|
72
|
+
pip install -e ".[dev]"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Quick Start
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# Interactive scaffold
|
|
79
|
+
specsmith init
|
|
80
|
+
|
|
81
|
+
# From config file
|
|
82
|
+
specsmith init --config scaffold.yml --no-git
|
|
83
|
+
|
|
84
|
+
# Guided scaffold with architecture definition
|
|
85
|
+
specsmith init --guided
|
|
86
|
+
|
|
87
|
+
# Import an existing project (generate governance overlay)
|
|
88
|
+
specsmith import --project-dir ./my-existing-project
|
|
89
|
+
specsmith import --project-dir ./my-existing-project --force
|
|
90
|
+
|
|
91
|
+
# Health checks on an existing governed project
|
|
92
|
+
specsmith audit --project-dir ./my-project
|
|
93
|
+
specsmith validate --project-dir ./my-project
|
|
94
|
+
|
|
95
|
+
# Ledger maintenance
|
|
96
|
+
specsmith compress --project-dir ./my-project
|
|
97
|
+
|
|
98
|
+
# Upgrade governance to newer spec version
|
|
99
|
+
specsmith upgrade --spec-version 0.2.0 --project-dir ./my-project
|
|
100
|
+
|
|
101
|
+
# VCS platform status (CI, alerts, PRs)
|
|
102
|
+
specsmith status --project-dir ./my-project
|
|
103
|
+
|
|
104
|
+
# Compare governance files against templates
|
|
105
|
+
specsmith diff --project-dir ./my-project
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Commands
|
|
109
|
+
|
|
110
|
+
| Command | Description |
|
|
111
|
+
|---------|-------------|
|
|
112
|
+
| `specsmith init` | Scaffold a new governed project (interactive or YAML-driven) |
|
|
113
|
+
| `specsmith init --guided` | Scaffold with interactive architecture definition (REQ/TEST stub generation) |
|
|
114
|
+
| `specsmith import` | Import an existing project and generate governance overlay |
|
|
115
|
+
| `specsmith audit [--fix]` | Drift detection and health checks; `--fix` auto-repairs missing files and oversized ledgers |
|
|
116
|
+
| `specsmith validate` | Governance consistency (scaffold.yml, AGENTS.md refs, REQ uniqueness, arch↔req linkage) |
|
|
117
|
+
| `specsmith compress` | Archive old ledger entries to `docs/ledger-archive.md` |
|
|
118
|
+
| `specsmith upgrade` | Re-render governance files for a new spec version |
|
|
119
|
+
| `specsmith status` | Show CI status, dependency alerts, and open PRs from VCS platform CLI |
|
|
120
|
+
| `specsmith diff` | Compare governance files against what spec templates would generate |
|
|
121
|
+
|
|
122
|
+
## Project Types
|
|
123
|
+
|
|
124
|
+
specsmith supports 30 project types, each with type-specific directory structures, CI tooling, and governance rules.
|
|
125
|
+
See [full project types reference](https://specsmith.readthedocs.io/project-types/) for details.
|
|
126
|
+
|
|
127
|
+
| # | Type | Spec Section | Verification Tools |
|
|
128
|
+
|---|------|-------------|--------------------|
|
|
129
|
+
| 1 | Python backend + web frontend | 17.1 | ruff, mypy, pytest, pip-audit |
|
|
130
|
+
| 2 | Python backend + web frontend + tray | 17.2 | ruff, mypy, pytest, pip-audit |
|
|
131
|
+
| 3 | CLI tool (Python) | 17.3 | ruff, mypy, pytest, pip-audit |
|
|
132
|
+
| 4 | Library / SDK (Python) | 17.4 | ruff, mypy, pytest, pip-audit |
|
|
133
|
+
| 5 | Embedded / hardware | 17.5 | clang-tidy, cppcheck, ctest, flawfinder |
|
|
134
|
+
| 6 | FPGA / RTL | 17.6 | vsg, verilator, ghdl, cocotb |
|
|
135
|
+
| 7 | Yocto / embedded Linux BSP | 17.7 | oelint-adv, bitbake |
|
|
136
|
+
| 8 | PCB / hardware design | 17.8 | drc-check, erc-check, kicad-cli |
|
|
137
|
+
| 9 | Web frontend (SPA) | 17.9 | eslint, tsc, vitest, prettier |
|
|
138
|
+
| 10 | Fullstack JS/TS | 17.10 | eslint, tsc, vitest, jest |
|
|
139
|
+
| 11 | CLI tool (Rust) | 17.11 | clippy, cargo check/test/audit, rustfmt |
|
|
140
|
+
| 12 | CLI tool (Go) | 17.12 | golangci-lint, go test, govulncheck |
|
|
141
|
+
| 13 | CLI tool (C/C++) | 17.13 | clang-tidy, cppcheck, ctest, clang-format |
|
|
142
|
+
| 14 | Library / crate (Rust) | 17.14 | clippy, cargo check/test/audit, rustfmt |
|
|
143
|
+
| 15 | Library (C/C++) | 17.15 | clang-tidy, cppcheck, ctest, clang-format |
|
|
144
|
+
| 16 | .NET / C# application | 17.16 | dotnet format/test/audit |
|
|
145
|
+
| 17 | Mobile app | 17.17 | flutter analyze/test, eslint |
|
|
146
|
+
| 18 | DevOps / IaC | 17.18 | tflint, ansible-lint, tfsec, checkov |
|
|
147
|
+
| 19 | Data / ML pipeline | 17.19 | ruff, mypy, pytest, pip-audit |
|
|
148
|
+
| 20 | Microservices | 17.20 | ruff, eslint, pytest, jest, docker compose |
|
|
149
|
+
| 21 | Technical specification | 17.21 | vale, markdownlint, cspell, pandoc |
|
|
150
|
+
| 22 | User manual / documentation | 17.22 | vale, markdownlint, cspell, sphinx |
|
|
151
|
+
| 23 | Research paper / white paper | 17.23 | vale, cspell, chktex, pdflatex |
|
|
152
|
+
| 24 | Business plan / proposal | 17.24 | vale, cspell, prettier, pandoc |
|
|
153
|
+
| 25 | Patent application | 17.25 | vale, cspell, pandoc, claim-ref-check |
|
|
154
|
+
| 26 | Legal / compliance | 17.26 | vale, cspell, pandoc, regulation-ref-check |
|
|
155
|
+
| 27 | Requirements management | 17.27 | vale, markdownlint, req-trace |
|
|
156
|
+
| 28 | API specification | 17.28 | spectral, buf lint, schemathesis |
|
|
157
|
+
| 29 | Monorepo (multi-package) | 17.29 | eslint, ruff, nx/turbo, npm audit |
|
|
158
|
+
| 30 | Browser extension | 17.30 | eslint, web-ext lint, tsc, vitest |
|
|
159
|
+
|
|
160
|
+
## Agent Integrations
|
|
161
|
+
|
|
162
|
+
specsmith generates agent-specific governance files so AI assistants understand your project's rules:
|
|
163
|
+
|
|
164
|
+
| Agent | Generated File |
|
|
165
|
+
|-------|---------------|
|
|
166
|
+
| **AGENTS.md** (cross-tool standard) | `AGENTS.md` (always) |
|
|
167
|
+
| Warp / Oz | `.warp/skills/SKILL.md` |
|
|
168
|
+
| Claude Code | `CLAUDE.md` |
|
|
169
|
+
| GitHub Copilot | `.github/copilot-instructions.md` |
|
|
170
|
+
| Cursor | `.cursor/rules/governance.mdc` |
|
|
171
|
+
| Gemini CLI | `GEMINI.md` |
|
|
172
|
+
| Windsurf | `.windsurfrules` |
|
|
173
|
+
| Aider | `.aider.conf.yml` |
|
|
174
|
+
|
|
175
|
+
## VCS Platform Support
|
|
176
|
+
|
|
177
|
+
CI configs are **tool-aware** — generated from the verification tool registry per project type.
|
|
178
|
+
|
|
179
|
+
| Platform | CLI | CI Config | Dependency Mgmt | Security |
|
|
180
|
+
|----------|-----|-----------|-----------------|----------|
|
|
181
|
+
| **GitHub** | `gh` | GitHub Actions | Dependabot (pip/cargo/gomod/npm/nuget) | Tool-specific per type |
|
|
182
|
+
| **GitLab** | `glab` | `.gitlab-ci.yml` | Renovate | Tool-specific per type |
|
|
183
|
+
| **Bitbucket** | `bb` | Bitbucket Pipelines | Renovate | Tool-specific per type |
|
|
184
|
+
|
|
185
|
+
## Branching Strategy
|
|
186
|
+
|
|
187
|
+
Configure one of three branching strategies per project:
|
|
188
|
+
|
|
189
|
+
- **gitflow** (default) — `main` + `develop` + feature/release/hotfix branches
|
|
190
|
+
- **trunk-based** — single `main` with short-lived feature branches
|
|
191
|
+
- **github-flow** — `main` + feature branches with PR-based workflow
|
|
192
|
+
|
|
193
|
+
Branch protection (required reviews, CI checks, no force push) is configurable.
|
|
194
|
+
|
|
195
|
+
## Configuration
|
|
196
|
+
|
|
197
|
+
Projects are configured via `scaffold.yml`:
|
|
198
|
+
|
|
199
|
+
```yaml
|
|
200
|
+
name: my-project
|
|
201
|
+
type: cli-python
|
|
202
|
+
platforms: [windows, linux, macos]
|
|
203
|
+
language: python
|
|
204
|
+
vcs_platform: github
|
|
205
|
+
branching_strategy: gitflow
|
|
206
|
+
require_pr_reviews: true
|
|
207
|
+
required_approvals: 1
|
|
208
|
+
require_ci_pass: true
|
|
209
|
+
integrations: [agents-md, warp, claude-code]
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
| `specsmith export` | Generate compliance report (REQ coverage, audit summary, tool status) |
|
|
213
|
+
|
|
214
|
+
## Documentation
|
|
215
|
+
|
|
216
|
+
Full documentation: [specsmith.readthedocs.io](https://specsmith.readthedocs.io)
|
|
217
|
+
|
|
218
|
+
## Specification
|
|
219
|
+
|
|
220
|
+
See [`docs/AGENT-WORKFLOW-SPEC.md`](docs/AGENT-WORKFLOW-SPEC.md) for the complete workflow specification.
|
|
221
|
+
|
|
222
|
+
## Development
|
|
223
|
+
|
|
224
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and guidelines.
|
|
225
|
+
|
|
226
|
+
## Security
|
|
227
|
+
|
|
228
|
+
See [SECURITY.md](SECURITY.md) for vulnerability reporting.
|
|
229
|
+
|
|
230
|
+
## License
|
|
231
|
+
|
|
232
|
+
MIT — Copyright (c) 2026 BitConcepts, LLC. See [LICENSE](LICENSE).
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# specsmith
|
|
2
|
+
|
|
3
|
+
[](https://github.com/BitConcepts/specsmith/actions/workflows/ci.yml)
|
|
4
|
+
[](https://specsmith.readthedocs.io/en/latest/)
|
|
5
|
+
[](https://www.python.org/downloads/)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
8
|
+
Forge governed project scaffolds from the Agentic AI Development Workflow Specification.
|
|
9
|
+
|
|
10
|
+
> Intelligence proposes. Constraints decide. The ledger remembers.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## What is specsmith?
|
|
15
|
+
|
|
16
|
+
`specsmith` is a CLI tool that generates full project scaffolds with built-in AI agent governance. It creates the file structure, CI/CD pipelines, governance documents, and agent integration files that AI coding assistants need to work within a structured, auditable workflow.
|
|
17
|
+
|
|
18
|
+
Every scaffolded project follows the closed-loop workflow: **propose → check → execute → verify → record**.
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pip install specsmith
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
From source:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
git clone https://github.com/BitConcepts/specsmith.git
|
|
30
|
+
cd specsmith
|
|
31
|
+
pip install -e ".[dev]"
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Quick Start
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# Interactive scaffold
|
|
38
|
+
specsmith init
|
|
39
|
+
|
|
40
|
+
# From config file
|
|
41
|
+
specsmith init --config scaffold.yml --no-git
|
|
42
|
+
|
|
43
|
+
# Guided scaffold with architecture definition
|
|
44
|
+
specsmith init --guided
|
|
45
|
+
|
|
46
|
+
# Import an existing project (generate governance overlay)
|
|
47
|
+
specsmith import --project-dir ./my-existing-project
|
|
48
|
+
specsmith import --project-dir ./my-existing-project --force
|
|
49
|
+
|
|
50
|
+
# Health checks on an existing governed project
|
|
51
|
+
specsmith audit --project-dir ./my-project
|
|
52
|
+
specsmith validate --project-dir ./my-project
|
|
53
|
+
|
|
54
|
+
# Ledger maintenance
|
|
55
|
+
specsmith compress --project-dir ./my-project
|
|
56
|
+
|
|
57
|
+
# Upgrade governance to newer spec version
|
|
58
|
+
specsmith upgrade --spec-version 0.2.0 --project-dir ./my-project
|
|
59
|
+
|
|
60
|
+
# VCS platform status (CI, alerts, PRs)
|
|
61
|
+
specsmith status --project-dir ./my-project
|
|
62
|
+
|
|
63
|
+
# Compare governance files against templates
|
|
64
|
+
specsmith diff --project-dir ./my-project
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Commands
|
|
68
|
+
|
|
69
|
+
| Command | Description |
|
|
70
|
+
|---------|-------------|
|
|
71
|
+
| `specsmith init` | Scaffold a new governed project (interactive or YAML-driven) |
|
|
72
|
+
| `specsmith init --guided` | Scaffold with interactive architecture definition (REQ/TEST stub generation) |
|
|
73
|
+
| `specsmith import` | Import an existing project and generate governance overlay |
|
|
74
|
+
| `specsmith audit [--fix]` | Drift detection and health checks; `--fix` auto-repairs missing files and oversized ledgers |
|
|
75
|
+
| `specsmith validate` | Governance consistency (scaffold.yml, AGENTS.md refs, REQ uniqueness, arch↔req linkage) |
|
|
76
|
+
| `specsmith compress` | Archive old ledger entries to `docs/ledger-archive.md` |
|
|
77
|
+
| `specsmith upgrade` | Re-render governance files for a new spec version |
|
|
78
|
+
| `specsmith status` | Show CI status, dependency alerts, and open PRs from VCS platform CLI |
|
|
79
|
+
| `specsmith diff` | Compare governance files against what spec templates would generate |
|
|
80
|
+
|
|
81
|
+
## Project Types
|
|
82
|
+
|
|
83
|
+
specsmith supports 30 project types, each with type-specific directory structures, CI tooling, and governance rules.
|
|
84
|
+
See [full project types reference](https://specsmith.readthedocs.io/project-types/) for details.
|
|
85
|
+
|
|
86
|
+
| # | Type | Spec Section | Verification Tools |
|
|
87
|
+
|---|------|-------------|--------------------|
|
|
88
|
+
| 1 | Python backend + web frontend | 17.1 | ruff, mypy, pytest, pip-audit |
|
|
89
|
+
| 2 | Python backend + web frontend + tray | 17.2 | ruff, mypy, pytest, pip-audit |
|
|
90
|
+
| 3 | CLI tool (Python) | 17.3 | ruff, mypy, pytest, pip-audit |
|
|
91
|
+
| 4 | Library / SDK (Python) | 17.4 | ruff, mypy, pytest, pip-audit |
|
|
92
|
+
| 5 | Embedded / hardware | 17.5 | clang-tidy, cppcheck, ctest, flawfinder |
|
|
93
|
+
| 6 | FPGA / RTL | 17.6 | vsg, verilator, ghdl, cocotb |
|
|
94
|
+
| 7 | Yocto / embedded Linux BSP | 17.7 | oelint-adv, bitbake |
|
|
95
|
+
| 8 | PCB / hardware design | 17.8 | drc-check, erc-check, kicad-cli |
|
|
96
|
+
| 9 | Web frontend (SPA) | 17.9 | eslint, tsc, vitest, prettier |
|
|
97
|
+
| 10 | Fullstack JS/TS | 17.10 | eslint, tsc, vitest, jest |
|
|
98
|
+
| 11 | CLI tool (Rust) | 17.11 | clippy, cargo check/test/audit, rustfmt |
|
|
99
|
+
| 12 | CLI tool (Go) | 17.12 | golangci-lint, go test, govulncheck |
|
|
100
|
+
| 13 | CLI tool (C/C++) | 17.13 | clang-tidy, cppcheck, ctest, clang-format |
|
|
101
|
+
| 14 | Library / crate (Rust) | 17.14 | clippy, cargo check/test/audit, rustfmt |
|
|
102
|
+
| 15 | Library (C/C++) | 17.15 | clang-tidy, cppcheck, ctest, clang-format |
|
|
103
|
+
| 16 | .NET / C# application | 17.16 | dotnet format/test/audit |
|
|
104
|
+
| 17 | Mobile app | 17.17 | flutter analyze/test, eslint |
|
|
105
|
+
| 18 | DevOps / IaC | 17.18 | tflint, ansible-lint, tfsec, checkov |
|
|
106
|
+
| 19 | Data / ML pipeline | 17.19 | ruff, mypy, pytest, pip-audit |
|
|
107
|
+
| 20 | Microservices | 17.20 | ruff, eslint, pytest, jest, docker compose |
|
|
108
|
+
| 21 | Technical specification | 17.21 | vale, markdownlint, cspell, pandoc |
|
|
109
|
+
| 22 | User manual / documentation | 17.22 | vale, markdownlint, cspell, sphinx |
|
|
110
|
+
| 23 | Research paper / white paper | 17.23 | vale, cspell, chktex, pdflatex |
|
|
111
|
+
| 24 | Business plan / proposal | 17.24 | vale, cspell, prettier, pandoc |
|
|
112
|
+
| 25 | Patent application | 17.25 | vale, cspell, pandoc, claim-ref-check |
|
|
113
|
+
| 26 | Legal / compliance | 17.26 | vale, cspell, pandoc, regulation-ref-check |
|
|
114
|
+
| 27 | Requirements management | 17.27 | vale, markdownlint, req-trace |
|
|
115
|
+
| 28 | API specification | 17.28 | spectral, buf lint, schemathesis |
|
|
116
|
+
| 29 | Monorepo (multi-package) | 17.29 | eslint, ruff, nx/turbo, npm audit |
|
|
117
|
+
| 30 | Browser extension | 17.30 | eslint, web-ext lint, tsc, vitest |
|
|
118
|
+
|
|
119
|
+
## Agent Integrations
|
|
120
|
+
|
|
121
|
+
specsmith generates agent-specific governance files so AI assistants understand your project's rules:
|
|
122
|
+
|
|
123
|
+
| Agent | Generated File |
|
|
124
|
+
|-------|---------------|
|
|
125
|
+
| **AGENTS.md** (cross-tool standard) | `AGENTS.md` (always) |
|
|
126
|
+
| Warp / Oz | `.warp/skills/SKILL.md` |
|
|
127
|
+
| Claude Code | `CLAUDE.md` |
|
|
128
|
+
| GitHub Copilot | `.github/copilot-instructions.md` |
|
|
129
|
+
| Cursor | `.cursor/rules/governance.mdc` |
|
|
130
|
+
| Gemini CLI | `GEMINI.md` |
|
|
131
|
+
| Windsurf | `.windsurfrules` |
|
|
132
|
+
| Aider | `.aider.conf.yml` |
|
|
133
|
+
|
|
134
|
+
## VCS Platform Support
|
|
135
|
+
|
|
136
|
+
CI configs are **tool-aware** — generated from the verification tool registry per project type.
|
|
137
|
+
|
|
138
|
+
| Platform | CLI | CI Config | Dependency Mgmt | Security |
|
|
139
|
+
|----------|-----|-----------|-----------------|----------|
|
|
140
|
+
| **GitHub** | `gh` | GitHub Actions | Dependabot (pip/cargo/gomod/npm/nuget) | Tool-specific per type |
|
|
141
|
+
| **GitLab** | `glab` | `.gitlab-ci.yml` | Renovate | Tool-specific per type |
|
|
142
|
+
| **Bitbucket** | `bb` | Bitbucket Pipelines | Renovate | Tool-specific per type |
|
|
143
|
+
|
|
144
|
+
## Branching Strategy
|
|
145
|
+
|
|
146
|
+
Configure one of three branching strategies per project:
|
|
147
|
+
|
|
148
|
+
- **gitflow** (default) — `main` + `develop` + feature/release/hotfix branches
|
|
149
|
+
- **trunk-based** — single `main` with short-lived feature branches
|
|
150
|
+
- **github-flow** — `main` + feature branches with PR-based workflow
|
|
151
|
+
|
|
152
|
+
Branch protection (required reviews, CI checks, no force push) is configurable.
|
|
153
|
+
|
|
154
|
+
## Configuration
|
|
155
|
+
|
|
156
|
+
Projects are configured via `scaffold.yml`:
|
|
157
|
+
|
|
158
|
+
```yaml
|
|
159
|
+
name: my-project
|
|
160
|
+
type: cli-python
|
|
161
|
+
platforms: [windows, linux, macos]
|
|
162
|
+
language: python
|
|
163
|
+
vcs_platform: github
|
|
164
|
+
branching_strategy: gitflow
|
|
165
|
+
require_pr_reviews: true
|
|
166
|
+
required_approvals: 1
|
|
167
|
+
require_ci_pass: true
|
|
168
|
+
integrations: [agents-md, warp, claude-code]
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
| `specsmith export` | Generate compliance report (REQ coverage, audit summary, tool status) |
|
|
172
|
+
|
|
173
|
+
## Documentation
|
|
174
|
+
|
|
175
|
+
Full documentation: [specsmith.readthedocs.io](https://specsmith.readthedocs.io)
|
|
176
|
+
|
|
177
|
+
## Specification
|
|
178
|
+
|
|
179
|
+
See [`docs/AGENT-WORKFLOW-SPEC.md`](docs/AGENT-WORKFLOW-SPEC.md) for the complete workflow specification.
|
|
180
|
+
|
|
181
|
+
## Development
|
|
182
|
+
|
|
183
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and guidelines.
|
|
184
|
+
|
|
185
|
+
## Security
|
|
186
|
+
|
|
187
|
+
See [SECURITY.md](SECURITY.md) for vulnerability reporting.
|
|
188
|
+
|
|
189
|
+
## License
|
|
190
|
+
|
|
191
|
+
MIT — Copyright (c) 2026 BitConcepts, LLC. See [LICENSE](LICENSE).
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68.0", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "specsmith"
|
|
7
|
+
version = "0.1.0a4"
|
|
8
|
+
description = "Forge governed project scaffolds from the Agentic AI Development Workflow Specification."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = {text = "MIT"}
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "BitConcepts"},
|
|
14
|
+
]
|
|
15
|
+
keywords = ["agentic", "scaffold", "governance", "agents-md", "cli", "specification"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Environment :: Console",
|
|
19
|
+
"Intended Audience :: Developers",
|
|
20
|
+
"License :: OSI Approved :: MIT License",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Programming Language :: Python :: 3.10",
|
|
23
|
+
"Programming Language :: Python :: 3.11",
|
|
24
|
+
"Programming Language :: Python :: 3.12",
|
|
25
|
+
"Programming Language :: Python :: 3.13",
|
|
26
|
+
"Topic :: Software Development :: Code Generators",
|
|
27
|
+
"Topic :: Software Development :: Build Tools",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
dependencies = [
|
|
31
|
+
"click>=8.1",
|
|
32
|
+
"jinja2>=3.1",
|
|
33
|
+
"pyyaml>=6.0",
|
|
34
|
+
"pydantic>=2.0",
|
|
35
|
+
"rich>=13.0",
|
|
36
|
+
]
|
|
37
|
+
|
|
38
|
+
[project.optional-dependencies]
|
|
39
|
+
dev = [
|
|
40
|
+
"pytest>=7.0",
|
|
41
|
+
"pytest-cov>=4.0",
|
|
42
|
+
"ruff>=0.4",
|
|
43
|
+
"mypy>=1.10",
|
|
44
|
+
"pre-commit>=3.0",
|
|
45
|
+
"types-pyyaml>=6.0",
|
|
46
|
+
]
|
|
47
|
+
docs = [
|
|
48
|
+
"mkdocs>=1.6",
|
|
49
|
+
"mkdocs-material>=9.5",
|
|
50
|
+
]
|
|
51
|
+
|
|
52
|
+
[project.scripts]
|
|
53
|
+
specsmith = "specsmith.cli:main"
|
|
54
|
+
|
|
55
|
+
[project.urls]
|
|
56
|
+
Homepage = "https://github.com/BitConcepts/specsmith"
|
|
57
|
+
Repository = "https://github.com/BitConcepts/specsmith"
|
|
58
|
+
Changelog = "https://github.com/BitConcepts/specsmith/blob/main/CHANGELOG.md"
|
|
59
|
+
|
|
60
|
+
[tool.setuptools.packages.find]
|
|
61
|
+
where = ["src"]
|
|
62
|
+
|
|
63
|
+
[tool.setuptools.package-data]
|
|
64
|
+
specsmith = ["templates/**/*.j2"]
|
|
65
|
+
|
|
66
|
+
[tool.ruff]
|
|
67
|
+
target-version = "py310"
|
|
68
|
+
line-length = 100
|
|
69
|
+
|
|
70
|
+
[tool.ruff.lint]
|
|
71
|
+
select = ["E", "F", "W", "I", "UP", "B", "SIM"]
|
|
72
|
+
|
|
73
|
+
[tool.mypy]
|
|
74
|
+
python_version = "3.10"
|
|
75
|
+
strict = true
|
|
76
|
+
warn_return_any = true
|
|
77
|
+
warn_unused_configs = true
|
|
78
|
+
|
|
79
|
+
[tool.pytest.ini_options]
|
|
80
|
+
testpaths = ["tests"]
|