aidlc-kit 0.3.0__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.
- aidlc_kit-0.3.0/.gitignore +17 -0
- aidlc_kit-0.3.0/LICENSE +97 -0
- aidlc_kit-0.3.0/PKG-INFO +181 -0
- aidlc_kit-0.3.0/README.md +164 -0
- aidlc_kit-0.3.0/pyproject.toml +31 -0
- aidlc_kit-0.3.0/src/aidlc_kit/__init__.py +3 -0
- aidlc_kit-0.3.0/src/aidlc_kit/cli.py +281 -0
- aidlc_kit-0.3.0/src/aidlc_kit/scaffold.py +1302 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/README.md +60 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/aidlc-state.md +44 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/archive/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/audit/audit-log.md +40 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/completion/bolt-completion-criteria.md +264 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/completion/consistency-check-prompt.md +157 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/completion/intent-consolidation-prompt.md +63 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/decisions/decision-log.md +106 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_definition.md +514 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_variants/egs_definition_agnostic.md +515 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_variants/egs_definition_aws.md +515 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_variants/egs_definition_azure.md +515 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_variants/egs_definition_gcp.md +515 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/egs_variants/egs_definition_onprem.md +515 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/extensions/README.md +46 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/extensions/security-extensions.md +234 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/intent-summaries/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/intents/intent-primary.md +34 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/overrides/guardrails_overrides.md +7 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/plan-templates/mob_construction_plan.md +49 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/retrospectives/session-retrospective.md +138 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/standards/content-validation.md +79 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/standards/error-handling.md +123 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/standards/question-format.md +56 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/base/welcome.md +18 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/code-elevation/dynamic_model.md +77 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/code-elevation/guardrails_gap_analysis.md +102 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/code-elevation/static_model.md +119 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/code-elevation/technical_debt.md +70 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/mob-construction/bolt-b1/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/mob-construction/bolt-b2/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/mob-construction/bolt-b3/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/mob-elaboration/guardrails_compliance_matrix.md +73 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/plan-templates/code_elevation_plan.md +44 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/plan-templates/mob_elaboration_plan.md +51 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/prompts/code-elevation.md +359 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/prompts/mob-construction.md +499 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/brownfield/prompts/mob-elaboration.md +406 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/mob-construction/bolt-1/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/mob-construction/bolt-2/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/mob-construction/bolt-3/.gitkeep +0 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/mob-elaboration/guardrails_compliance_matrix.md +73 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/plan-templates/mob_elaboration_plan.md +48 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/prompts/mob-construction.md +416 -0
- aidlc_kit-0.3.0/src/aidlc_kit/templates/greenfield/prompts/mob-elaboration.md +352 -0
- aidlc_kit-0.3.0/tests/test_scaffold.py +405 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.pyc
|
|
4
|
+
*.egg-info/
|
|
5
|
+
dist/
|
|
6
|
+
build/
|
|
7
|
+
|
|
8
|
+
# Virtual environment
|
|
9
|
+
.venv/
|
|
10
|
+
|
|
11
|
+
# Test cache
|
|
12
|
+
.pytest_cache/
|
|
13
|
+
|
|
14
|
+
# Local-only files (not part of the distributed package)
|
|
15
|
+
reports/
|
|
16
|
+
FUTURE_FEATURES.md
|
|
17
|
+
PROJECT_CONTEXT.md
|
aidlc_kit-0.3.0/LICENSE
ADDED
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
Business Source License 1.1
|
|
2
|
+
|
|
3
|
+
Parameters
|
|
4
|
+
|
|
5
|
+
Licensor: Ricardo González Vargas
|
|
6
|
+
Licensed Work: aidlc-kit 0.3.0
|
|
7
|
+
The Licensed Work is (c) 2026 Ricardo González Vargas.
|
|
8
|
+
Additional Use Grant: You may use the Licensed Work in production to scaffold
|
|
9
|
+
and manage AI-DLC projects for your own organization or
|
|
10
|
+
your clients. You may not:
|
|
11
|
+
(a) offer the Licensed Work, or a substantially similar
|
|
12
|
+
derivative, as a hosted service, managed service, or
|
|
13
|
+
SaaS product;
|
|
14
|
+
(b) sell, distribute, or sublicense the Licensed Work or
|
|
15
|
+
a derivative as a standalone scaffolding or project
|
|
16
|
+
generation tool that competes with the Licensed Work.
|
|
17
|
+
Change Date: 2030-02-27
|
|
18
|
+
Change License: Apache License, Version 2.0
|
|
19
|
+
|
|
20
|
+
For information about alternative licensing arrangements for the Licensed Work,
|
|
21
|
+
please contact: rgonv@hotmail.com
|
|
22
|
+
|
|
23
|
+
Notice
|
|
24
|
+
|
|
25
|
+
The Business Source License (this document, or the "License") is not an Open
|
|
26
|
+
Source license. However, the Licensed Work will eventually be made available
|
|
27
|
+
under an Open Source License, as stated in this License.
|
|
28
|
+
|
|
29
|
+
License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
|
|
30
|
+
"Business Source License" is a trademark of MariaDB Corporation Ab.
|
|
31
|
+
|
|
32
|
+
Terms
|
|
33
|
+
|
|
34
|
+
The Licensor hereby grants you the right to copy, modify, create derivative
|
|
35
|
+
works, redistribute, and make non-production use of the Licensed Work. The
|
|
36
|
+
Licensor may make an Additional Use Grant, above, permitting limited
|
|
37
|
+
production use.
|
|
38
|
+
|
|
39
|
+
Effective on the Change Date, or the fourth anniversary of the first publicly
|
|
40
|
+
available distribution of a specific version of the Licensed Work under this
|
|
41
|
+
License, whichever comes first, the Licensor hereby grants you rights under
|
|
42
|
+
the terms of the Change License, and the rights granted in the paragraph
|
|
43
|
+
above terminate.
|
|
44
|
+
|
|
45
|
+
If your use of the Licensed Work does not comply with the requirements
|
|
46
|
+
currently in effect as described in this License, you must purchase a
|
|
47
|
+
commercial license from the Licensor, its affiliated entities, or authorized
|
|
48
|
+
resellers, or you must refrain from using the Licensed Work.
|
|
49
|
+
|
|
50
|
+
All copies of the original and modified Licensed Work, and derivative works
|
|
51
|
+
of the Licensed Work, are subject to this License. This License applies
|
|
52
|
+
separately for each version of the Licensed Work and the Change Date may vary
|
|
53
|
+
for each version of the Licensed Work released by Licensor.
|
|
54
|
+
|
|
55
|
+
You must conspicuously display this License on each original or modified copy
|
|
56
|
+
of the Licensed Work. If you receive the Licensed Work in original or
|
|
57
|
+
modified form from a third party, the terms and conditions set forth in this
|
|
58
|
+
License apply to your use of that work.
|
|
59
|
+
|
|
60
|
+
Any use of the Licensed Work in violation of this License will automatically
|
|
61
|
+
terminate your rights under this License for the current and all other
|
|
62
|
+
versions of the Licensed Work.
|
|
63
|
+
|
|
64
|
+
This License does not grant you any right in any trademark or logo of
|
|
65
|
+
Licensor or its affiliates (provided that you may use a trademark or logo of
|
|
66
|
+
Licensor as expressly required by this License).
|
|
67
|
+
|
|
68
|
+
TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
|
|
69
|
+
AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
|
|
70
|
+
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
|
|
71
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
|
|
72
|
+
TITLE.
|
|
73
|
+
|
|
74
|
+
MariaDB hereby grants you permission to use this License's text to license
|
|
75
|
+
your works, and to refer to it using the trademark "Business Source License",
|
|
76
|
+
as long as you comply with the Covenants of Licensor below.
|
|
77
|
+
|
|
78
|
+
Covenants of Licensor
|
|
79
|
+
|
|
80
|
+
In consideration of the right to use this License's text and the "Business
|
|
81
|
+
Source License" name and trademark, Licensor covenants to MariaDB, and to all
|
|
82
|
+
other recipients of the licensed work to be provided by Licensor:
|
|
83
|
+
|
|
84
|
+
1. To specify as the Change License the GPL Version 2.0 or any later version,
|
|
85
|
+
or a license that is compatible with GPL Version 2.0 or a later version,
|
|
86
|
+
where "compatible" means that software provided under the Change License
|
|
87
|
+
can be included in a program with software provided under GPL Version 2.0
|
|
88
|
+
or a later version. Licensor may specify additional Change Licenses without
|
|
89
|
+
limitation.
|
|
90
|
+
|
|
91
|
+
2. To either: (a) specify an additional grant of rights to use that does not
|
|
92
|
+
impose any additional restriction on the right granted in this License, as
|
|
93
|
+
the Additional Use Grant; or (b) insert the text "None".
|
|
94
|
+
|
|
95
|
+
3. To specify a Change Date.
|
|
96
|
+
|
|
97
|
+
4. Not to modify this License in any other way.
|
aidlc_kit-0.3.0/PKG-INFO
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: aidlc-kit
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Scaffold AI-DLC projects with enterprise guardrails, prompts, and compliance templates.
|
|
5
|
+
Author-email: Ricardo González Vargas <rgonv@hotmail.com>
|
|
6
|
+
License: BUSL-1.1
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Keywords: ai-dlc,enterprise,governance,guardrails,scaffold
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: License :: Other/Proprietary License
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
14
|
+
Requires-Python: >=3.11
|
|
15
|
+
Requires-Dist: click>=8.1
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# aidlc-kit
|
|
19
|
+
|
|
20
|
+
Scaffold AI-DLC projects with prompts, templates, and consistency checks.
|
|
21
|
+
|
|
22
|
+
**aidlc-kit** is the companion CLI tool for the [AI-DLC methodology](https://ricardogonzalez.me), as described in *Reimagine, Don't Retrofit* by Ricardo González Vargas. The book provides the methodology, principles, and rituals; this tool provides the project scaffolding to put them into practice.
|
|
23
|
+
|
|
24
|
+
## Install
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install aidlc-kit
|
|
28
|
+
# or with uv
|
|
29
|
+
uv tool install aidlc-kit
|
|
30
|
+
# or run without installing
|
|
31
|
+
uvx aidlc-kit
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Quick Start
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# Scaffold a new project (interactive wizard)
|
|
38
|
+
aidlc-kit init my-project
|
|
39
|
+
|
|
40
|
+
# Non-interactive
|
|
41
|
+
aidlc-kit init my-project --mode greenfield --platform aws --ide kiro
|
|
42
|
+
|
|
43
|
+
# Brownfield (existing codebase)
|
|
44
|
+
cd existing-repo
|
|
45
|
+
aidlc-kit init . --mode brownfield --platform aws --ide kiro
|
|
46
|
+
|
|
47
|
+
# Enterprise tier (adds EGS guardrails, compliance matrix, gap analysis)
|
|
48
|
+
aidlc-kit init my-project --mode greenfield --platform aws --tier enterprise
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Commands
|
|
52
|
+
|
|
53
|
+
| Command | Purpose |
|
|
54
|
+
|---------|---------|
|
|
55
|
+
| `init` | Scaffold a new AI-DLC project |
|
|
56
|
+
| `check` | Validate project health and consistency |
|
|
57
|
+
| `status` | Show current project progress dashboard |
|
|
58
|
+
| `update` | Update kit-owned templates to latest version |
|
|
59
|
+
| `archive` | Archive completed intent and reset workspace |
|
|
60
|
+
| `export-egs` | Export the project's EGS definition to a file |
|
|
61
|
+
| `import-egs` | Import an external EGS definition into the project |
|
|
62
|
+
| `consistency` | Run structural consistency checks across artifacts |
|
|
63
|
+
|
|
64
|
+
## What It Creates
|
|
65
|
+
|
|
66
|
+
### Standard tier (default)
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
aidlc-docs/
|
|
70
|
+
├── README.md ← Project card (name, mode, platform, tier)
|
|
71
|
+
├── aidlc-state.md ← Session state tracking
|
|
72
|
+
├── intents/
|
|
73
|
+
│ └── intent-primary.md ← Blank intent template
|
|
74
|
+
├── prompts/ ← AI-DLC prompt templates
|
|
75
|
+
│ ├── mob-elaboration.md
|
|
76
|
+
│ ├── mob-construction.md
|
|
77
|
+
│ └── code-elevation.md ← (brownfield only)
|
|
78
|
+
├── plan-templates/ ← Plan templates for AI to populate
|
|
79
|
+
│ ├── mob_elaboration_plan.md
|
|
80
|
+
│ ├── mob_construction_plan.md
|
|
81
|
+
│ └── code_elevation_plan.md ← (brownfield only)
|
|
82
|
+
├── code-elevation/ ← (brownfield only)
|
|
83
|
+
│ ├── static_model.md
|
|
84
|
+
│ ├── dynamic_model.md
|
|
85
|
+
│ └── technical_debt.md
|
|
86
|
+
├── mob-elaboration/
|
|
87
|
+
├── mob-construction/
|
|
88
|
+
│ ├── bolt-1/ (or bolt-b1/)
|
|
89
|
+
│ ├── bolt-2/ (or bolt-b2/)
|
|
90
|
+
│ └── bolt-3/ (or bolt-b3/)
|
|
91
|
+
├── standards/ ← Content validation, error handling, question format
|
|
92
|
+
├── completion/ ← Bolt criteria, consistency check, intent consolidation
|
|
93
|
+
├── decisions/
|
|
94
|
+
│ └── decision-log.md
|
|
95
|
+
├── retrospectives/
|
|
96
|
+
│ └── session-retrospective.md
|
|
97
|
+
├── audit/
|
|
98
|
+
│ └── audit-log.md
|
|
99
|
+
├── intent-summaries/
|
|
100
|
+
└── archive/
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Enterprise tier (`--tier enterprise`)
|
|
104
|
+
|
|
105
|
+
Adds on top of standard:
|
|
106
|
+
- `egs_definition.md` — Enterprise Guardrails Specification (10 categories, customize per project)
|
|
107
|
+
- `mob-elaboration/guardrails_compliance_matrix.md` — Story-to-guardrail mapping
|
|
108
|
+
- `code-elevation/guardrails_gap_analysis.md` — Codebase violation-to-guardrail mapping (brownfield only)
|
|
109
|
+
- `overrides/guardrails_overrides.md` — Guardrail exception tracking
|
|
110
|
+
- Prompt templates include EGS validation gates at every phase/stage
|
|
111
|
+
|
|
112
|
+
## Options
|
|
113
|
+
|
|
114
|
+
### Modes
|
|
115
|
+
- `greenfield` — New project. Mob Elaboration and Mob Construction prompts.
|
|
116
|
+
- `brownfield` — Existing codebase. Adds Code Elevation prompt and templates for static model, dynamic model, and technical debt analysis.
|
|
117
|
+
|
|
118
|
+
### Platforms
|
|
119
|
+
`aws`, `azure`, `gcp`, `onprem`, `agnostic` — Tailors the EGS definition template to the target platform.
|
|
120
|
+
|
|
121
|
+
### Tiers
|
|
122
|
+
- `standard` (default) — Core AI-DLC workflow without guardrails enforcement.
|
|
123
|
+
- `enterprise` — Adds EGS guardrails, compliance matrix, gap analysis, and validation gates. Use when you have regulatory, security, or governance requirements.
|
|
124
|
+
|
|
125
|
+
### IDE Support
|
|
126
|
+
|
|
127
|
+
Generate router configs for your IDE with `--ide`. Use `--ide all` for every supported IDE.
|
|
128
|
+
|
|
129
|
+
| Tool | Link |
|
|
130
|
+
|------|------|
|
|
131
|
+
| agents-md | [agents.md](https://agents.md/) |
|
|
132
|
+
| aider | [aider.chat](https://aider.chat/) |
|
|
133
|
+
| amp | [ampcode.com](https://ampcode.com/) |
|
|
134
|
+
| auggie | [augmentcode.com](https://www.augmentcode.com/) |
|
|
135
|
+
| claude-code | [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code/overview) |
|
|
136
|
+
| cline | [cline.bot](https://cline.bot/) |
|
|
137
|
+
| codebuddy | [codebuddy.ai](https://codebuddy.ai/) |
|
|
138
|
+
| codex | [openai.com/codex](https://openai.com/index/openai-codex/) |
|
|
139
|
+
| copilot | [github.com/features/copilot](https://github.com/features/copilot) |
|
|
140
|
+
| copilot-cli | [docs.github.com/copilot-cli](https://docs.github.com/en/copilot/how-tos/copilot-cli) |
|
|
141
|
+
| costrict | [docs.costrict.ai](https://docs.costrict.ai/) |
|
|
142
|
+
| crush | [github.com/charmbracelet/crush](https://github.com/charmbracelet/crush) |
|
|
143
|
+
| cursor | [cursor.com](https://www.cursor.com/) |
|
|
144
|
+
| factory-droid | [factory.ai](https://www.factory.ai/) |
|
|
145
|
+
| gemini | [gemini.google.com](https://gemini.google.com/) |
|
|
146
|
+
| gemini-cli | [github.com/google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) |
|
|
147
|
+
| iflow | [iflow.cn](https://platform.iflow.cn/en/cli/quickstart) |
|
|
148
|
+
| kilo-code | [kilocode.ai](https://kilocode.ai/) |
|
|
149
|
+
| kiro | [kiro.dev](https://kiro.dev/) |
|
|
150
|
+
| opencode | [opencode.ai](https://opencode.ai/) |
|
|
151
|
+
| q-developer | [aws.amazon.com/q/developer](https://aws.amazon.com/q/developer/) |
|
|
152
|
+
| qoder | [qodo.ai](https://www.qodo.ai/) |
|
|
153
|
+
| roo-code | [roocode.com](https://roocode.com/) |
|
|
154
|
+
| windsurf | [windsurf.com](https://windsurf.com/) |
|
|
155
|
+
|
|
156
|
+
## Workflow
|
|
157
|
+
|
|
158
|
+
1. Open your project in your IDE and ask: "Start Mob Elaboration"
|
|
159
|
+
2. The AI will ask you to describe your intent (or read it from `intents/intent-primary.md` if you wrote one ahead of time)
|
|
160
|
+
3. AI generates the elaboration plan (stories, units, bolts)
|
|
161
|
+
4. Run Mob Construction bolt by bolt
|
|
162
|
+
5. Use `aidlc-kit check` between bolts to validate consistency
|
|
163
|
+
6. Use `aidlc-kit archive` when the intent is complete, then start the next one
|
|
164
|
+
|
|
165
|
+
For enterprise tier, also customize `egs_definition.md` before step 1.
|
|
166
|
+
|
|
167
|
+
## Upgrading to Enterprise
|
|
168
|
+
|
|
169
|
+
Start with standard and upgrade later without re-scaffolding:
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
aidlc-kit update --tier enterprise
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
This adds the enterprise-only files and updates templates with EGS validation gates.
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
Business Source License 1.1 — see [LICENSE](LICENSE) for details.
|
|
180
|
+
|
|
181
|
+
Free to use for scaffolding and managing your AI-DLC projects. You may not offer this tool, or a derivative, as a competing product or hosted service. Converts to Apache 2.0 on 2030-02-27.
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# aidlc-kit
|
|
2
|
+
|
|
3
|
+
Scaffold AI-DLC projects with prompts, templates, and consistency checks.
|
|
4
|
+
|
|
5
|
+
**aidlc-kit** is the companion CLI tool for the [AI-DLC methodology](https://ricardogonzalez.me), as described in *Reimagine, Don't Retrofit* by Ricardo González Vargas. The book provides the methodology, principles, and rituals; this tool provides the project scaffolding to put them into practice.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install aidlc-kit
|
|
11
|
+
# or with uv
|
|
12
|
+
uv tool install aidlc-kit
|
|
13
|
+
# or run without installing
|
|
14
|
+
uvx aidlc-kit
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Scaffold a new project (interactive wizard)
|
|
21
|
+
aidlc-kit init my-project
|
|
22
|
+
|
|
23
|
+
# Non-interactive
|
|
24
|
+
aidlc-kit init my-project --mode greenfield --platform aws --ide kiro
|
|
25
|
+
|
|
26
|
+
# Brownfield (existing codebase)
|
|
27
|
+
cd existing-repo
|
|
28
|
+
aidlc-kit init . --mode brownfield --platform aws --ide kiro
|
|
29
|
+
|
|
30
|
+
# Enterprise tier (adds EGS guardrails, compliance matrix, gap analysis)
|
|
31
|
+
aidlc-kit init my-project --mode greenfield --platform aws --tier enterprise
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Commands
|
|
35
|
+
|
|
36
|
+
| Command | Purpose |
|
|
37
|
+
|---------|---------|
|
|
38
|
+
| `init` | Scaffold a new AI-DLC project |
|
|
39
|
+
| `check` | Validate project health and consistency |
|
|
40
|
+
| `status` | Show current project progress dashboard |
|
|
41
|
+
| `update` | Update kit-owned templates to latest version |
|
|
42
|
+
| `archive` | Archive completed intent and reset workspace |
|
|
43
|
+
| `export-egs` | Export the project's EGS definition to a file |
|
|
44
|
+
| `import-egs` | Import an external EGS definition into the project |
|
|
45
|
+
| `consistency` | Run structural consistency checks across artifacts |
|
|
46
|
+
|
|
47
|
+
## What It Creates
|
|
48
|
+
|
|
49
|
+
### Standard tier (default)
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
aidlc-docs/
|
|
53
|
+
├── README.md ← Project card (name, mode, platform, tier)
|
|
54
|
+
├── aidlc-state.md ← Session state tracking
|
|
55
|
+
├── intents/
|
|
56
|
+
│ └── intent-primary.md ← Blank intent template
|
|
57
|
+
├── prompts/ ← AI-DLC prompt templates
|
|
58
|
+
│ ├── mob-elaboration.md
|
|
59
|
+
│ ├── mob-construction.md
|
|
60
|
+
│ └── code-elevation.md ← (brownfield only)
|
|
61
|
+
├── plan-templates/ ← Plan templates for AI to populate
|
|
62
|
+
│ ├── mob_elaboration_plan.md
|
|
63
|
+
│ ├── mob_construction_plan.md
|
|
64
|
+
│ └── code_elevation_plan.md ← (brownfield only)
|
|
65
|
+
├── code-elevation/ ← (brownfield only)
|
|
66
|
+
│ ├── static_model.md
|
|
67
|
+
│ ├── dynamic_model.md
|
|
68
|
+
│ └── technical_debt.md
|
|
69
|
+
├── mob-elaboration/
|
|
70
|
+
├── mob-construction/
|
|
71
|
+
│ ├── bolt-1/ (or bolt-b1/)
|
|
72
|
+
│ ├── bolt-2/ (or bolt-b2/)
|
|
73
|
+
│ └── bolt-3/ (or bolt-b3/)
|
|
74
|
+
├── standards/ ← Content validation, error handling, question format
|
|
75
|
+
├── completion/ ← Bolt criteria, consistency check, intent consolidation
|
|
76
|
+
├── decisions/
|
|
77
|
+
│ └── decision-log.md
|
|
78
|
+
├── retrospectives/
|
|
79
|
+
│ └── session-retrospective.md
|
|
80
|
+
├── audit/
|
|
81
|
+
│ └── audit-log.md
|
|
82
|
+
├── intent-summaries/
|
|
83
|
+
└── archive/
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Enterprise tier (`--tier enterprise`)
|
|
87
|
+
|
|
88
|
+
Adds on top of standard:
|
|
89
|
+
- `egs_definition.md` — Enterprise Guardrails Specification (10 categories, customize per project)
|
|
90
|
+
- `mob-elaboration/guardrails_compliance_matrix.md` — Story-to-guardrail mapping
|
|
91
|
+
- `code-elevation/guardrails_gap_analysis.md` — Codebase violation-to-guardrail mapping (brownfield only)
|
|
92
|
+
- `overrides/guardrails_overrides.md` — Guardrail exception tracking
|
|
93
|
+
- Prompt templates include EGS validation gates at every phase/stage
|
|
94
|
+
|
|
95
|
+
## Options
|
|
96
|
+
|
|
97
|
+
### Modes
|
|
98
|
+
- `greenfield` — New project. Mob Elaboration and Mob Construction prompts.
|
|
99
|
+
- `brownfield` — Existing codebase. Adds Code Elevation prompt and templates for static model, dynamic model, and technical debt analysis.
|
|
100
|
+
|
|
101
|
+
### Platforms
|
|
102
|
+
`aws`, `azure`, `gcp`, `onprem`, `agnostic` — Tailors the EGS definition template to the target platform.
|
|
103
|
+
|
|
104
|
+
### Tiers
|
|
105
|
+
- `standard` (default) — Core AI-DLC workflow without guardrails enforcement.
|
|
106
|
+
- `enterprise` — Adds EGS guardrails, compliance matrix, gap analysis, and validation gates. Use when you have regulatory, security, or governance requirements.
|
|
107
|
+
|
|
108
|
+
### IDE Support
|
|
109
|
+
|
|
110
|
+
Generate router configs for your IDE with `--ide`. Use `--ide all` for every supported IDE.
|
|
111
|
+
|
|
112
|
+
| Tool | Link |
|
|
113
|
+
|------|------|
|
|
114
|
+
| agents-md | [agents.md](https://agents.md/) |
|
|
115
|
+
| aider | [aider.chat](https://aider.chat/) |
|
|
116
|
+
| amp | [ampcode.com](https://ampcode.com/) |
|
|
117
|
+
| auggie | [augmentcode.com](https://www.augmentcode.com/) |
|
|
118
|
+
| claude-code | [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code/overview) |
|
|
119
|
+
| cline | [cline.bot](https://cline.bot/) |
|
|
120
|
+
| codebuddy | [codebuddy.ai](https://codebuddy.ai/) |
|
|
121
|
+
| codex | [openai.com/codex](https://openai.com/index/openai-codex/) |
|
|
122
|
+
| copilot | [github.com/features/copilot](https://github.com/features/copilot) |
|
|
123
|
+
| copilot-cli | [docs.github.com/copilot-cli](https://docs.github.com/en/copilot/how-tos/copilot-cli) |
|
|
124
|
+
| costrict | [docs.costrict.ai](https://docs.costrict.ai/) |
|
|
125
|
+
| crush | [github.com/charmbracelet/crush](https://github.com/charmbracelet/crush) |
|
|
126
|
+
| cursor | [cursor.com](https://www.cursor.com/) |
|
|
127
|
+
| factory-droid | [factory.ai](https://www.factory.ai/) |
|
|
128
|
+
| gemini | [gemini.google.com](https://gemini.google.com/) |
|
|
129
|
+
| gemini-cli | [github.com/google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) |
|
|
130
|
+
| iflow | [iflow.cn](https://platform.iflow.cn/en/cli/quickstart) |
|
|
131
|
+
| kilo-code | [kilocode.ai](https://kilocode.ai/) |
|
|
132
|
+
| kiro | [kiro.dev](https://kiro.dev/) |
|
|
133
|
+
| opencode | [opencode.ai](https://opencode.ai/) |
|
|
134
|
+
| q-developer | [aws.amazon.com/q/developer](https://aws.amazon.com/q/developer/) |
|
|
135
|
+
| qoder | [qodo.ai](https://www.qodo.ai/) |
|
|
136
|
+
| roo-code | [roocode.com](https://roocode.com/) |
|
|
137
|
+
| windsurf | [windsurf.com](https://windsurf.com/) |
|
|
138
|
+
|
|
139
|
+
## Workflow
|
|
140
|
+
|
|
141
|
+
1. Open your project in your IDE and ask: "Start Mob Elaboration"
|
|
142
|
+
2. The AI will ask you to describe your intent (or read it from `intents/intent-primary.md` if you wrote one ahead of time)
|
|
143
|
+
3. AI generates the elaboration plan (stories, units, bolts)
|
|
144
|
+
4. Run Mob Construction bolt by bolt
|
|
145
|
+
5. Use `aidlc-kit check` between bolts to validate consistency
|
|
146
|
+
6. Use `aidlc-kit archive` when the intent is complete, then start the next one
|
|
147
|
+
|
|
148
|
+
For enterprise tier, also customize `egs_definition.md` before step 1.
|
|
149
|
+
|
|
150
|
+
## Upgrading to Enterprise
|
|
151
|
+
|
|
152
|
+
Start with standard and upgrade later without re-scaffolding:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
aidlc-kit update --tier enterprise
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
This adds the enterprise-only files and updates templates with EGS validation gates.
|
|
159
|
+
|
|
160
|
+
## License
|
|
161
|
+
|
|
162
|
+
Business Source License 1.1 — see [LICENSE](LICENSE) for details.
|
|
163
|
+
|
|
164
|
+
Free to use for scaffolding and managing your AI-DLC projects. You may not offer this tool, or a derivative, as a competing product or hosted service. Converts to Apache 2.0 on 2030-02-27.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "aidlc-kit"
|
|
7
|
+
version = "0.3.0"
|
|
8
|
+
description = "Scaffold AI-DLC projects with enterprise guardrails, prompts, and compliance templates."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = { text = "BUSL-1.1" }
|
|
11
|
+
requires-python = ">=3.11"
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "Ricardo González Vargas", email = "rgonv@hotmail.com" },
|
|
14
|
+
]
|
|
15
|
+
keywords = ["ai-dlc", "guardrails", "scaffold", "enterprise", "governance"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"License :: Other/Proprietary License",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
22
|
+
]
|
|
23
|
+
dependencies = [
|
|
24
|
+
"click>=8.1",
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
[project.scripts]
|
|
28
|
+
aidlc-kit = "aidlc_kit.cli:main"
|
|
29
|
+
|
|
30
|
+
[tool.hatch.build.targets.wheel]
|
|
31
|
+
packages = ["src/aidlc_kit"]
|