Metadata-Version: 2.4
Name: aidlc-kit
Version: 0.14.0
Summary: Scaffold AI-DLC projects with enterprise guardrails, prompts, and compliance templates.
Project-URL: Homepage, https://reimaginedontretrofit.com
Project-URL: Blog, https://blog.ricardogonzalez.me
Project-URL: Repository, https://github.com/rgonv/aidlc-kit
Project-URL: Documentation, https://pypi.org/project/aidlc-kit/
Project-URL: AI-DLC Methodology, https://prod.d13rzhkk8cj2z0.amplifyapp.com/
Project-URL: Book, https://leanpub.com/reimaginedontretrofit
Project-URL: AboutMe, https://ricardogonzalez.me
Author: Ricardo González Vargas
License: BUSL-1.1
License-File: LICENSE
Keywords: ai-dlc,enterprise,governance,guardrails,scaffold
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.11
Requires-Dist: aidlc-profile-software>=0.13.0
Requires-Dist: click>=8.1
Description-Content-Type: text/markdown

# aidlc-kit

AI-DLC project scaffolding engine with plugin-based solution profiles.

**aidlc-kit** is the companion CLI tool for the [AI-DLC methodology](https://prod.d13rzhkk8cj2z0.amplifyapp.com/), originally introduced by Raja SP in the [AWS DevOps Blog](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/) and further expanded with [open-source adaptive workflows](https://aws.amazon.com/blogs/devops/open-sourcing-adaptive-workflows-for-ai-driven-development-life-cycle-ai-dlc/). The methodology is extended with additional rituals, enterprise guardrails, brownfield workflows, and tooling in [Reimagine, Don't Retrofit](https://leanpub.com/reimaginedontretrofit) by Ricardo González Vargas. The book provides the methodology, principles, and rituals; this tool provides the project scaffolding to put them into practice.

## Install

```bash
pip install aidlc-kit
# or with uv
uv tool install aidlc-kit
# or run without installing
uvx aidlc-kit
```

Installing `aidlc-kit` also installs the default `software` profile, which provides the software development workflow (Mob Elaboration, Mob Construction, Code Elevation).

## Quick Start

```bash
# Scaffold a new project (interactive wizard)
aidlc-kit init my-project

# Non-interactive
aidlc-kit init my-project --mode greenfield --platform aws --ide kiro

# Brownfield (existing codebase)
cd existing-repo
aidlc-kit init . --mode brownfield --platform azure --ide copilot
```

## Solution Profiles

aidlc-kit is a workflow engine. The actual templates, prompts, and ritual definitions live in profile packages. Each profile targets a different workflow.

```bash
# List installed profiles
aidlc-kit profiles list

# Use a specific profile
aidlc-kit init my-project --profile software   # default
```

Profiles are discovered via Python entry points (`aidlc_kit.profiles` group). Install any profile package and it appears automatically in `profiles list`. Profiles can also declare CLI commands that are registered dynamically at startup.

## Engine Commands

| Command | Purpose |
|---------|---------|
| `init` | Scaffold a new AI-DLC project |
| `check` | Validate project health and template drift |
| `status` | Show current project progress dashboard |
| `update` | Update kit-owned templates to latest version |
| `archive` | Archive completed work and reset workspace |
| `profiles` | List installed solution profiles |
| `version` | Show versions of engine and installed profiles |

Profiles can declare additional commands via the `cli_commands` contract field. The `software` profile adds `consistency`, `validate-plan`, `extensions`, `intent`, and `bolt`. See each profile's README for its commands.

## What the Engine Does

The engine provides profile-agnostic scaffolding mechanics:

- Copies templates from the active profile's `templates_path` into `aidlc-docs/`
- Applies platform overlays (`aws/`, `azure/`, `gcp/`, etc.) on top of base templates
- Renders conditional blocks (`{{#tierName}}...{{/tierName}}`) based on the active tier
- Replaces placeholders (`{{PROJECT_NAME}}`, `{{PLATFORM}}`, `{{KIT_VERSION}}`)
- Generates IDE router configs and Agent Skills for 24 supported IDEs
- Generates MCP server configs from profile declarations
- Detects template drift, tier upgrades, and project health via `check`
- Protects user-owned files (state, intents, decisions) during `update`

What gets scaffolded depends entirely on the installed profile.

## IDE Support

Generate router configs for your IDE with `--ide`. Use `--ide all` for every supported IDE.

| Tool | Link |
|------|------|
| agents-md | [agents.md](https://agents.md/) |
| aider | [aider.chat](https://aider.chat/) |
| amp | [ampcode.com](https://ampcode.com/) |
| auggie | [augmentcode.com](https://www.augmentcode.com/) |
| claude-code | [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code/overview) |
| cline | [cline.bot](https://cline.bot/) |
| codebuddy | [codebuddy.ai](https://codebuddy.ai/) |
| codex | [openai.com/codex](https://openai.com/index/openai-codex/) |
| copilot | [github.com/features/copilot](https://github.com/features/copilot) |
| copilot-cli | [docs.github.com/copilot-cli](https://docs.github.com/en/copilot/how-tos/copilot-cli) |
| costrict | [docs.costrict.ai](https://docs.costrict.ai/) |
| crush | [github.com/charmbracelet/crush](https://github.com/charmbracelet/crush) |
| cursor | [cursor.com](https://www.cursor.com/) |
| factory-droid | [factory.ai](https://www.factory.ai/) |
| gemini | [gemini.google.com](https://gemini.google.com/) |
| gemini-cli | [github.com/google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) |
| iflow | [iflow.cn](https://platform.iflow.cn/en/cli/quickstart) |
| kilo-code | [kilocode.ai](https://kilocode.ai/) |
| kiro | [kiro.dev](https://kiro.dev/) |
| opencode | [opencode.ai](https://opencode.ai/) |
| q-developer | [aws.amazon.com/q/developer](https://aws.amazon.com/q/developer/) |
| qoder | [qodo.ai](https://www.qodo.ai/) |
| roo-code | [roocode.com](https://roocode.com/) |
| windsurf | [windsurf.com](https://windsurf.com/) |

## Profile Contract

Profiles declare their capabilities via a Python dict. The engine uses these fields to drive scaffolding, validation, and CLI behavior:

| Field | Purpose |
|-------|---------|
| `name`, `display_name`, `version` | Identity |
| `rituals` | Workflow phases (e.g., `["elaboration", "construction"]`) |
| `modes` | Project modes (e.g., `["greenfield", "brownfield"]`) or `None` |
| `platforms` | Deployment targets (e.g., `["aws", "azure"]`) or `None` |
| `tiers` | Feature tiers (e.g., `["standard", "enterprise"]`) or `None` |
| `templates_path` | Path to the profile's template directory |
| `skills` | Agent Skills for Tier 1 IDEs |
| `cli_commands` | Click commands registered at startup |
| `user_owned` | Files the engine must never overwrite on update |
| `tier_files` | Files that exist only at specific tiers |
| `mcp_server_configs` | MCP server declarations for IDE config scaffolding |

Profile extensions use `extends` to add capabilities to a base profile (e.g., `tiers_add`, `skills_add`, `cli_commands_add`).

## License

Business Source License 1.1 — see [LICENSE](LICENSE) for details.

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.
