Skip to content

Commit 1475c19

Browse files
DavidHacheDavid Hacheharmjeffscottschreckengaust
authored
feat: agent-driven setup — drop the manual steps (#109)
* feat: agent-driven setup — flatten rules, drop the manual steps As AI agents get better at following instructions, it opens up simpler ways to solve problems we used to handle with scripts and commands. Rather than maintaining platform-specific setup steps for every IDE, we now provide a single prompt and let the agent create the right config file for its environment. Flattened aidlc-rules/ into one directory. Added SETUP.md with a two-step process: git submodule add, then paste the prompt. The agent handles the rest. * docs: update documentation and remove outdated setup images * fix: restore original aws-aidlc-rules/ and aws-aidlc-rule-details/ folder structure Workshops and tests depend on the original directory names. Reverts the flatten from 94619af while keeping the AI-driven setup approach. - Move rule details back to aidlc-rules/aws-aidlc-rule-details/ - Move core-workflow back to aidlc-rules/aws-aidlc-rules/ - Add .aidlc/aidlc-rules/aws-aidlc-rule-details/ as first path in core-workflow.md resolution, keeping legacy paths as fallbacks - Update SETUP.md, README.md, CONTRIBUTING.md for restored structure - Add "Do Not Rename or Move" guidance to CONTRIBUTING.md - Update submodule URL to awslabs/aidlc-workflows.git * docs: update changelog for v0.1.7 * Changed AI setup to experimental feature. * docs: replace submodule setup with release-download in experimental AI-assisted setup Replace the git submodule approach with a GitHub API-based release download. The agent now queries the latest release, downloads the versioned zip asset, and extracts the rules — no .gitmodules or submodule tracking needed. Revert CHANGELOG.md to upstream. * docs: clarify rule-details path resolution is setup-method agnostic Update path fallback labels from definitive platform assignments to "typical with" hints, and add explicit note that resolution order applies regardless of IDE or setup method used. * Apply suggestion from @scottschreckengaust Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com> * Update CHANGELOG.md Removed extra line. * fix: Markdown lint Updated instructions for setting up AI-DLC in the project. * fix: markdown lint --------- Co-authored-by: David Hache <hachd@amazon.com> Co-authored-by: Jeff Harman <109810187+harmjeff@users.noreply.github.com> Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
1 parent 927735d commit 1475c19

3 files changed

Lines changed: 79 additions & 7 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,26 @@ Before contributing, familiarize yourself with our [tenets](README.md#tenets).
1212

1313
AI-DLC rules live in `aidlc-rules/aws-aidlc-rule-details/`. When contributing:
1414

15-
- **Be reproducible**: Changes should be consistently reproducible either via test case or a series of step
15+
- **Be reproducible**: Changes should be consistently reproducible either via test case or a series of steps.
1616
- **Single source of truth**: Don't duplicate content. If guidance applies to multiple stages, put it in `common/` and reference it.
1717
- **Keep it agnostic**: The core methodology shouldn't assume specific IDEs, agents, or models. Tool-specific files are generated from the source.
1818

19+
### Directory Structure — Do Not Rename or Move
20+
21+
The folder names `aws-aidlc-rules/` and `aws-aidlc-rule-details/` under `aidlc-rules/` are part of the public contract. Workshops, tests, and the `core-workflow.md` path-resolution logic all depend on these exact names. Do not flatten, rename, or reorganize them.
22+
23+
```text
24+
aidlc-rules/
25+
├── aws-aidlc-rules/ # Core workflow entry point
26+
│ └── core-workflow.md
27+
└── aws-aidlc-rule-details/ # Detailed rules referenced by the workflow
28+
├── common/
29+
├── inception/
30+
├── construction/
31+
├── extensions/
32+
└── operations/
33+
```
34+
1935
### Rule Structure
2036

2137
Rules are organized by phase:
@@ -24,6 +40,7 @@ Rules are organized by phase:
2440
- `inception/` - Planning and architecture rules
2541
- `construction/` - Design and implementation rules
2642
- `operations/` - Deployment and monitoring rules
43+
- `extensions/` - Optional cross-cutting constraint rules
2744

2845
### Testing Changes
2946

‎README.md‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
88

99
## Table of Contents
1010

11-
- [Quick Start](#quick-start)
11+
- [Common](#common)
12+
- [Experimental: AI-Assisted Setup (Release Download)](#experimental-ai-assisted-setup-release-download)
1213
- [Platform-Specific Setup](#platform-specific-setup)
1314
- [Usage](#usage)
1415
- [Three-Phase Adaptive Workflow](#three-phase-adaptive-workflow)
@@ -24,7 +25,7 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
2425

2526
---
2627

27-
## Quick Start
28+
## Common
2829

2930
1. Download the latest release zip from the [Releases page](../../releases/latest) to a folder **outside** your project directory (e.g., `~/Downloads`).
3031
2. Extract the zip. It contains an `aidlc-rules/` folder with two subdirectories:
@@ -34,6 +35,59 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
3435

3536
---
3637

38+
### Experimental: AI-Assisted Setup (Release Download)
39+
40+
> Instead of manually copying files, let your AI agent handle the setup. This is an experimental workflow — currently validated with Kiro, Claude code, Cursor, Antigravity.
41+
>
42+
> **Note:** This approach requires your agent to have shell access (e.g., Kiro, Claude Code, Cline). For agents without shell access, follow the [Common](#common) setup above.
43+
44+
Paste this prompt into your AI agent:
45+
46+
```text
47+
Set up AI-DLC in this project by doing the following:
48+
49+
1. Download the latest AI-DLC release:
50+
- Use the GitHub API to find the latest release asset URL:
51+
curl -sL https://api.github.com/repos/awslabs/aidlc-workflows/releases/latest \
52+
| grep -o '"browser_download_url": *"[^"]*"' \
53+
| head -1 \
54+
| cut -d'"' -f4
55+
- Download the zip from that URL to /tmp/aidlc-rules.zip
56+
- Extract it: unzip -o /tmp/aidlc-rules.zip -d /tmp/aidlc-release
57+
- Copy the aidlc-rules/ folder from the extracted contents into .aidlc at the project root
58+
- Clean up: rm -rf /tmp/aidlc-rules.zip /tmp/aidlc-release
59+
60+
2. Create the appropriate rules/steering file for your IDE using the options below.
61+
Pick the one that matches the agent you are running in:
62+
63+
- Kiro IDE or Kiro CLI → create `.kiro/steering/ai-dlc.md`
64+
- Amazon Q Developer → create `.amazonq/rules/ai-dlc.md`
65+
- Antigravity → create `.agent/rules/ai-dlc.md`
66+
- Cursor → create `.cursor/rules/ai-dlc.mdc` with frontmatter:
67+
---
68+
description: "AI-DLC workflow"
69+
alwaysApply: true
70+
---
71+
- Cline → create `.clinerules/ai-dlc.md`
72+
- Claude Code → create `CLAUDE.md`
73+
- GitHub Copilot → create `.github/copilot-instructions.md`
74+
- Any other agent → create `AGENTS.md`
75+
76+
3. The file content should be:
77+
When the user invokes AI-DLC, read and follow
78+
`.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md` to start the workflow.
79+
80+
4. Add `.aidlc` to `.gitignore` unless I explicitly ask you not to.
81+
82+
5. Confirm what file you created and that `.aidlc` is gitignored.
83+
```
84+
85+
The agent will download the latest release, create the correct config file for your IDE, and gitignore the `.aidlc` directory automatically.
86+
87+
**Updating AI-DLC** — Re-run the prompt above. The agent will download the latest release and overwrite the existing `.aidlc/` folder.
88+
89+
---
90+
3791
## Platform-Specific Setup
3892

3993
- [Kiro](#kiro)

‎aidlc-rules/aws-aidlc-rules/core-workflow.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ The AI model intelligently assesses what stages are needed based on:
1111
4. Risk and impact assessment
1212

1313
## MANDATORY: Rule Details Loading
14-
**CRITICAL**: When performing any phase, you MUST read and use relevant content from rule detail files. Check these paths in order and use the first one that exists:
15-
- `.aidlc-rule-details/` (Cursor, Cline, Claude Code, GitHub Copilot)
16-
- `.kiro/aws-aidlc-rule-details/` (Kiro IDE and CLI)
17-
- `.amazonq/aws-aidlc-rule-details/` (Amazon Q Developer)
14+
**CRITICAL**: When performing any phase, you MUST read and use relevant content from rule detail files. Check these paths in order and use the first one that exists, regardless of which IDE or setup method was used:
15+
- `.aidlc/aidlc-rules/aws-aidlc-rule-details/` (typical with AI-assisted setup)
16+
- `.aidlc-rule-details/` (typical with Cursor, Cline, Claude Code, GitHub Copilot)
17+
- `.kiro/aws-aidlc-rule-details/` (typical with Kiro IDE and CLI)
18+
- `.amazonq/aws-aidlc-rule-details/` (typical with Amazon Q Developer)
1819

1920
All subsequent rule detail file references (e.g., `common/process-overview.md`, `inception/workspace-detection.md`) are relative to whichever rule details directory was resolved above.
2021

0 commit comments

Comments
 (0)