# aidlc-workflows **Repository Path**: freesource_zhouliang/aidlc-workflows ## Basic Information - **Project Name**: aidlc-workflows - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT-0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-06-27 - **Last Updated**: 2026-06-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # AI-DLC (AI-Driven Development Life Cycle) ## 🚀 **Announcing 2.0 (Preview)** We're excited to announce the Preview release of AI-DLC Workflows 2.0. The new version makes autonomous software development practical by turning AI agents into verifiable, self-correcting engineering workflows. You can read the [full specification here](https://github.com/awslabs/aidlc-workflows/blob/v2/assets/AI-DLC-Workflows-2.0-Specification.pdf) and check the [v2 branch](https://github.com/awslabs/aidlc-workflows/tree/v2). We would love to hear from you, and your feedback will directly shape the path to GA. If you have suggestions, please reach out or interact with us on the repository. > [!IMPORTANT] > Generative AI can make mistakes. You should consider reviewing all output and costs generated by your chosen AI model and agentic coding assistant. See [AWS Responsible AI Policy](https://aws.amazon.com/ai/responsible-ai/policy/). AI-DLC is an intelligent software development workflow that adapts to your needs, maintains quality standards, and keeps you in control of the process. For learning more about AI-DLC Methodology, read this [blog](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/) and the [Method Definition Paper](https://prod.d13rzhkk8cj2z0.amplifyapp.com/) referred in it. ## Table of Contents - [Common](#common) - [Platform-Specific Setup](#platform-specific-setup) - [Usage](#usage) - [Three-Phase Adaptive Workflow](#three-phase-adaptive-workflow) - [Key Features](#key-features) - [Extensions](#extensions) - [Supporting Tools](#supporting-tools) - [Tenets](#tenets) - [Prerequisites](#prerequisites) - [Troubleshooting](#troubleshooting) - [Version Control Recommendations](#version-control-recommendations) - [Additional Resources](#additional-resources) - [Generated aidlc-docs/ Reference](#generated-aidlc-docs-reference) - [Experimental: AI-Assisted Setup (Release Download)](#experimental-ai-assisted-setup-release-download) - [Contributing](#contributing) - [License](#license) --- ## Common 1. Download the latest release zip file named `ai-dlc-rules-v.zip` from the [Releases page](https://github.com/awslabs/aidlc-workflows/releases/latest) to a folder **outside** your project directory (e.g., `~/Downloads`). 2. Extract the zip. It contains an `aidlc-rules/` folder with two subdirectories: - `aws-aidlc-rules/` — the core AI-DLC workflow rules - `aws-aidlc-rule-details/` — detailed rules conditionally referenced by the core rules 3. Follow the setup instructions for your coding agent and platform below. --- ## Platform-Specific Setup - [Kiro](#kiro) - [Amazon Q Developer IDE Plugin](#amazon-q-developer-ide-pluginextension) - [Cursor IDE](#cursor-ide) - [Cline](#cline) - [Claude Code](#claude-code) - [GitHub Copilot](#github-copilot) --- ### Kiro AI-DLC uses [Kiro Steering Files](https://kiro.dev/docs/cli/steering/) within your project workspace. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. On macOS/Linux: ```bash mkdir -p .kiro/steering cp -R ~/Downloads/aidlc-rules/aws-aidlc-rules .kiro/steering/ cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details .kiro/ ``` On Windows (PowerShell): ```powershell New-Item -ItemType Directory -Force -Path ".kiro\steering" Copy-Item -Recurse "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules" ".kiro\steering\" Copy-Item -Recurse "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details" ".kiro\" ``` On Windows (CMD): ```cmd mkdir .kiro\steering xcopy %USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules .kiro\steering\aws-aidlc-rules\ /E /I xcopy %USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details .kiro\aws-aidlc-rule-details\ /E /I ``` Your project should look like: ```text / ├── .kiro/ │ ├── steering/ │ │ ├── aws-aidlc-rules/ │ ├── aws-aidlc-rule-details/ ``` To verify the rules are loaded: #### Verify in Kiro IDE Open the steering files panel and confirm you see an entry for `core-workflow` under `Workspace` as shown in the screenshot below. AI-DLC Rules in Kiro IDE We use Kiro IDE in Vibe mode to run the AI-DLC workflow. This ensures that AI-DLC workflow guides the development workflow in Kiro. At times, Kiro may nudge you to switch to spec mode. Select `No` to such prompts to stay in Vibe mode. Staying in Kiro Vibe mode #### Verify in Kiro CLI Run `kiro-cli`, then `/context show`, and confirm entries for `.kiro/steering/aws-aidlc-rules`. AI-DLC Rules in Kiro CLI --- ### Amazon Q Developer IDE Plugin/Extension AI-DLC uses [Amazon Q Rules](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/context-project-rules.html) within your project workspace. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. On macOS/Linux: ```bash mkdir -p .amazonq/rules cp -R ~/Downloads/aidlc-rules/aws-aidlc-rules .amazonq/rules/ cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details .amazonq/ ``` On Windows (PowerShell): ```powershell New-Item -ItemType Directory -Force -Path ".amazonq\rules" Copy-Item -Recurse "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules" ".amazonq\rules\" Copy-Item -Recurse "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details" ".amazonq\" ``` On Windows (CMD): ```cmd mkdir .amazonq\rules xcopy %USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules .amazonq\rules\aws-aidlc-rules\ /E /I xcopy %USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details .amazonq\aws-aidlc-rule-details\ /E /I ``` Your project should look like: ```text / ├── .amazonq/ │ ├── rules/ │ │ ├── aws-aidlc-rules/ │ ├── aws-aidlc-rule-details/ ``` To verify the rules are loaded: 1. In the Amazon Q Chat window, click the `Rules` button in the lower right corner. 2. Confirm you see entries for `.amazonq/rules/aws-aidlc-rules`. AI-DLC Rules in Q Developer IDE plugin --- ### Cursor IDE AI-DLC uses [Cursor Rules](https://cursor.com/docs/context/rules) to implement its intelligent workflow. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. #### Option 1: Project Rules (Recommended) **Unix/Linux/macOS:** ```bash mkdir -p .cursor/rules cat > .cursor/rules/ai-dlc-workflow.mdc << 'EOF' --- description: "AI-DLC (AI-Driven Development Life Cycle) adaptive workflow for software development" alwaysApply: true --- EOF cat ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md >> .cursor/rules/ai-dlc-workflow.mdc mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell New-Item -ItemType Directory -Force -Path ".cursor\rules" $frontmatter = @" --- description: "AI-DLC (AI-Driven Development Life Cycle) adaptive workflow for software development" alwaysApply: true --- "@ $frontmatter | Out-File -FilePath ".cursor\rules\ai-dlc-workflow.mdc" -Encoding utf8 Get-Content "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" | Add-Content ".cursor\rules\ai-dlc-workflow.mdc" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd mkdir .cursor\rules ( echo --- echo description: "AI-DLC (AI-Driven Development Life Cycle) adaptive workflow for software development" echo alwaysApply: true echo --- echo. ) > .cursor\rules\ai-dlc-workflow.mdc type "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" >> .cursor\rules\ai-dlc-workflow.mdc mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` #### Option 2: AGENTS.md (Simple Alternative) **Unix/Linux/macOS:** ```bash cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./AGENTS.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` **Verify Setup:** 1. Open **Cursor Settings → Rules, Commands** 2. Under **Project Rules**, you should see `ai-dlc-workflow` listed 3. For `AGENTS.md`, it will be automatically detected and applied ![AI-DLC Rules in Cursor](./assets/images/cursor-ide-aidlc-rules-loaded.png?raw=true "AI-DLC Rules in Cursor") **Directory Structure (Option 1):** ```text / ├── .cursor/ │ └── rules/ │ └── ai-dlc-workflow.mdc └── .aidlc-rule-details/ ├── common/ ├── inception/ ├── construction/ ├── extensions/ └── operations/ ``` --- ### Cline AI-DLC uses Cline Rules to implement its intelligent workflow. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. #### Option 1: .clinerules Directory (Recommended) **Unix/Linux/macOS:** ```bash mkdir -p .clinerules cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md .clinerules/ mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell New-Item -ItemType Directory -Force -Path ".clinerules" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".clinerules\" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd mkdir .clinerules copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".clinerules\" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` #### Option 2: AGENTS.md (Alternative) **Unix/Linux/macOS:** ```bash cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./AGENTS.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` **Verify Setup:** 1. In Cline's chat interface, look for the Rules popover under the chat input field 2. Verify that `core-workflow.md` is listed and active 3. You can toggle the rule file on/off as needed ![AI-DLC Rules in Cline](./assets/images/cline-ide-aidlc-rules-loaded.png?raw=true "AI-DLC Rules in Cline") **Directory Structure (Option 1):** ```text / ├── .clinerules/ │ └── core-workflow.md └── .aidlc-rule-details/ ├── common/ ├── inception/ ├── construction/ ├── extensions/ └── operations/ ``` --- ### Claude Code AI-DLC uses Claude Code's project memory file (`CLAUDE.md`) to implement its intelligent workflow. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. #### Option 1: Project Root (Recommended) **Unix/Linux/macOS:** ```bash cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./CLAUDE.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\CLAUDE.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\CLAUDE.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` #### Option 2: .claude Directory **Unix/Linux/macOS:** ```bash mkdir -p .claude cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md .claude/CLAUDE.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell New-Item -ItemType Directory -Force -Path ".claude" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".claude\CLAUDE.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd mkdir .claude copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".claude\CLAUDE.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` **Verify Setup:** 1. Start Claude Code in your project directory (CLI: `claude` or VS Code extension) 2. Use the `/config` command to view current configuration 3. Ask Claude: "What instructions are currently active in this project?" **Directory Structure (Option 1):** ```text / ├── CLAUDE.md └── .aidlc-rule-details/ ├── common/ ├── inception/ ├── construction/ ├── extensions/ └── operations/ ``` --- ### GitHub Copilot AI-DLC uses [GitHub Copilot custom instructions](https://code.visualstudio.com/docs/copilot/customization/custom-instructions) to implement its intelligent workflow. The `.github/copilot-instructions.md` file is automatically detected and applied to all chat requests in the workspace. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. **Unix/Linux/macOS:** ```bash mkdir -p .github cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md .github/copilot-instructions.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell New-Item -ItemType Directory -Force -Path ".github" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".github\copilot-instructions.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd mkdir .github copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".github\copilot-instructions.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` **Verify Setup:** 1. Open VS Code with your project folder 2. Open the Copilot Chat panel (Cmd/Ctrl+Shift+I) 3. Select **Configure Chat** (gear icon) > **Chat Instructions** and verify that `copilot-instructions` is listed 4. Alternatively, type `/instructions` in the chat input to view active instructions **Directory Structure:** ```text / ├── .github/ │ └── copilot-instructions.md └── .aidlc-rule-details/ ├── common/ ├── inception/ ├── construction/ ├── extensions/ └── operations/ ``` --- ### OpenAI Codex AI-DLC supports OpenAI Codex as a supported coding agent, using the [Codex AGENTS.md](https://developers.openai.com/codex/guides/agents-md) convention to deliver its intelligent workflow. Codex automatically discovers and loads `AGENTS.md` from your project root when you start a session. The commands below assume you extracted the zip to your `Downloads` folder so that the resulting path is `Downloads/aidlc-rules/`. If you used a different location, replace `Downloads` with your actual folder path. > [!NOTE] > **Windows users:** if you used File Explorer's **Extract All...** dialog, it defaults to creating a wrapper folder named after the zip (e.g., `ai-dlc-rules-v0.1.8\aidlc-rules\...`). Either uncheck/edit that destination so the contents land directly in `Downloads\aidlc-rules\` (matching the commands below), or prepend `ai-dlc-rules-v\` to each `Downloads\` path in the commands — substituting `` with the release you downloaded. **Unix/Linux/macOS:** ```bash cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./AGENTS.md mkdir -p .aidlc-rule-details cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ ``` **Windows PowerShell:** ```powershell Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse ``` **Windows CMD:** ```cmd copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" mkdir .aidlc-rule-details xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I ``` **Verify Setup:** 1. Start a Codex session in your project directory 2. Ask Codex: For existing project - "Using AIDLC analyze the project?" or For new project "Using Aidlc what workflow do you see" . 3. Codex should describe the AI-DLC three-phase workflow (Inception → Construction → Operations) > [!NOTE] > The `AGENTS.md` file is designed to fit within Codex's instruction budget under default settings. If you add substantial project-specific content and Codex reports that the project documentation exceeds its instruction limit, you can increase the limit in your Codex configuration (for example, by adjusting `project_doc_max_bytes` in your `config.toml` file): > > ```toml > project_doc_max_bytes = 65536 # Example value; choose a limit appropriate for your project > ``` **Directory Structure:** ```text / ├── AGENTS.md └── .aidlc-rule-details/ ├── common/ ├── inception/ ├── construction/ ├── extensions/ └── operations/ ``` --- ### Other Agents AI-DLC works with any coding agent that supports project-level rules or steering files. The general approach: 1. Place `aws-aidlc-rules/` wherever your agent reads project rules from (consult your agent's documentation). 2. Place `aws-aidlc-rule-details/` at a sibling level so the rules can reference it. If your agent has no convention for rules files, place both folders at your project root and point the agent to `aws-aidlc-rules/` as its rules directory. --- ## Usage 1. Start any software development project by stating your intent starting with the phrase **"Using AI-DLC, ..."** in the chat 2. AI-DLC workflow automatically activates and guides you from there 3. Answer structured questions that AI-DLC asks you 4. Carefully review every plan that AI generates. Provide your oversight and validation 5. Review the execution plan to see which stages will run 6. Carefully review the artifacts and approve each stage to maintain control 7. All the artifacts will be generated in the `aidlc-docs/` directory --- ## Three-Phase Adaptive Workflow AI-DLC follows a structured three-phase approach that adapts to your project's complexity: ### 🔵 INCEPTION PHASE Determines **WHAT** to build and **WHY** - Requirements analysis and validation - User story creation (when applicable) - Application Design and creating units of work for parallel development - Risk assessment and complexity evaluation ### 🟢 CONSTRUCTION PHASE Determines **HOW** to build it - Detailed component design - Code generation and implementation - Build configuration and testing strategies - Quality assurance and validation ### 🟡 OPERATIONS PHASE Deployment and monitoring (future) - Deployment automation and infrastructure - Monitoring and observability setup - Production readiness validation --- ## Key Features | Feature | Description | | ------------------------- | --------------------------------------------------------------------------------------------------------- | | **Adaptive Intelligence** | Only executes stages that add value to your specific request | | **Context-Aware** | Analyzes existing codebase and complexity requirements | | **Risk-Based** | Complex changes get comprehensive treatment, simple changes stay efficient | | **Question-Driven** | Structured multiple-choice questions in files, not chat | | **Always in Control** | Review execution plans and approve each phase | | **Extensible** | Layer custom rules e.g. security, compliance, and organization-specific rules on top of the core workflow | --- ## Extensions AI-DLC supports an extension system that lets you layer additional rules on top of the core workflow. Extensions are markdown files organized under `aws-aidlc-rule-details/extensions/` and grouped by category (e.g., `security/`, `testing/`, `resiliency/`). ### How Extensions Work Each extension consists of two files placed in the same directory: - A **rules file** (e.g., `security-baseline.md`) containing the extension's rules. - An **opt-in file** (e.g., `security-baseline.opt-in.md`) containing a structured multiple-choice question presented to the user during Requirements Analysis. At workflow start, AI-DLC scans the `extensions/` directory and loads only `*.opt-in.md` files. During Requirements Analysis, it presents each opt-in prompt to the user. When the user opts in, the corresponding rules file is loaded (derived by naming convention: strip `.opt-in.md`, append `.md`). When the user opts out, the rules file is never loaded. Extensions without a matching `*.opt-in.md` file are always enforced. Once enabled, extension rules are blocking constraints — at each stage, the model verifies compliance before allowing the stage to proceed. ### Built-in Extensions The `extensions/` directory ships with the following (new extensions may be added over time): ```text aws-aidlc-rule-details/ └── extensions/ ├── security/ # Extension category │ └── baseline/ │ ├── security-baseline.md # Baseline security rules │ └── security-baseline.opt-in.md # Opt-in prompt ├── testing/ # Extension category │ └── property-based/ │ ├── property-based-testing.md # Property-based testing rules │ └── property-based-testing.opt-in.md # Opt-in prompt ├── resiliency/ │ └── baseline/ │ ├── resiliency-baseline.md # Baseline resiliency rules │ └── resiliency-baseline.opt-in.md # Opt-in prompt ``` > [!IMPORTANT] > The security extension rules are provided as a directional reference for building effective security rules within AI-DLC workflows. Each organization should build, customize, and thoroughly test their own security rules before deploying in production workflows. > > The resiliency extension rules are provided as a directional best practices for building resilient workloads rules within AI-DLC workflows. Each organization should build, customize, and thoroughly test their own resiliency rules before deploying in production workflows. ### Adding Your Own Extensions You can extend an existing category or create an entirely new one. 1. Create a directory under `extensions/` (e.g., `security/compliance/` or `performance/baseline/`). 2. Add a **rules file** (e.g., `compliance.md`). Follow the same structure as `security-baseline.md`: - Define each rule as a heading in the format `## Rule : ` where the prefix is a short category identifier and NN is a sequential number (e.g., `COMPLIANCE-01`, `COMPLIANCE-02`). These IDs are referenced in audit logs and compliance summaries, so they must be unique across all loaded extensions. - Include a **Rule** section describing the requirement. - Include a **Verification** section with concrete checks the model should evaluate. 3. Add a matching **opt-in file** using the naming convention `<name>.opt-in.md` (e.g., `compliance.opt-in.md`). See `security-baseline.opt-in.md` for the expected format. Omitting this file means the extension is always enforced with no user opt-out. 4. Rules are blocking by default — if verification criteria are not met, the stage cannot proceed until the finding is resolved. --- ## Supporting Tools The `scripts/` directory contains supporting tools that enhance the AI-DLC workflow: ### AIDLC Evaluator **Location:** [`scripts/aidlc-evaluator/`](scripts/aidlc-evaluator/) Automated testing and reporting framework for validating changes to AI-DLC workflows. The evaluator provides: - **Golden Test Cases** — Curated baseline test cases for validation - **Execution Framework** — Orchestration for running test cases through evaluation pipelines - **Semantic Evaluation** — AI-based assessment of output correctness and completeness - **Code Evaluation** — Static analysis (linting, security scanning, duplication detection) - **NFR Evaluation** — Non-functional requirements testing (token usage, execution time, cross-model consistency) - **CI/CD Integration** — Automated pipelines for PR validation **Quick Start:** ```bash cd scripts/aidlc-evaluator uv sync uv run python run.py test ``` **Documentation:** See [scripts/aidlc-evaluator/README.md](scripts/aidlc-evaluator/README.md) --- ### AIDLC Design Reviewer **Location:** [`scripts/aidlc-designreview/`](scripts/aidlc-designreview/) ⚠️ **EXPERIMENTAL FEATURE** — AI-powered design review tool that analyzes AIDLC design artifacts using Claude models via AWS Bedrock. **Features:** - **Multi-Agent Review** — Three specialized AI agents (Critique, Alternatives, Gap Analysis) - **Quality Scoring** — Weighted severity analysis with actionable recommendations - **Two Deployment Modes:** - **CLI Tool** — On-demand reviews for CI/CD pipelines - **Claude Code Hook** — Real-time review during development (experimental) **Installation (CLI Tool):** ```bash cd scripts/aidlc-designreview uv sync --extra test source .venv/bin/activate # Linux/Mac design-reviewer --aidlc-docs /path/to/aidlc-docs ``` **Installation (Claude Code Hook):** ```bash # From workspace root ./scripts/aidlc-designreview/tool-install/install-linux.sh # Linux ./scripts/aidlc-designreview/tool-install/install-mac.sh # macOS .\scripts\aidlc-designreview\tool-install\install-windows.ps1 # Windows PowerShell ``` The installer automatically detects your workspace root and installs the hook to `.claude/`. **Documentation:** - [scripts/aidlc-designreview/README.md](scripts/aidlc-designreview/README.md) — Main documentation - [scripts/aidlc-designreview/INSTALLATION.md](scripts/aidlc-designreview/INSTALLATION.md) — Hook installation guide --- ## Tenets These are our core principles to guide our decision making. - **No duplication**. The source of truth lives in one place. If we add support for new tools or formats that require specific files, we generate them from the source rather than maintaining separate copies. - **Methodology first**. AI-DLC is fundamentally a methodology, not a tool. Users shouldn't need to install anything to get started. That said, we're open to convenience tooling (scripts, CLIs) down the road if it helps users adopt or extend the methodology. - **Reproducible**. Rules should be clear enough that different models produce similar outcomes. We know models behave differently, but the methodology should minimize variance through explicit guidance. - **Agnostic**. The methodology works with any IDE, agent, or model. We don't tie ourselves to specific tools or vendors. - **Human in the loop**. Critical decisions require explicit user confirmation. The agent proposes, the human approves. --- ## Prerequisites Have one of our supported platforms/tools for Assisted AI Coding installed: | Platform | Installation Link | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Kiro | [Install](https://kiro.dev/) | | Kiro CLI | [Install](https://kiro.dev/cli/) | | Amazon Q Developer IDE Plugin | [Install](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/q-in-IDE.html) | | Cursor IDE | [Install](https://cursor.com/) | | Cline VS Code Extension | [Install](https://marketplace.visualstudio.com/items?itemName=saoudrizwan.claude-dev) | | Claude Code CLI | [Install](https://github.com/anthropics/claude-code) | | GitHub Copilot | [Install](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) + [Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) | --- ## Troubleshooting ### General Issues | Problem | Solution | | ---------------------------- | ----------------------------------------------------------- | | Rules not loading | Check file exists in the correct location for your platform | | File encoding issues | Ensure files are UTF-8 encoded | | Rules not applied in session | Start a new chat session after file changes | | Rule details not loading | Verify `.aidlc-rule-details/` exists with subdirectories | ### Platform-Specific Issues #### Amazon Q Developer / Kiro - Use `/context show` to verify rules are loaded - Check `.amazonq/rules/` or `.kiro/steering/` directory structure #### Cursor - For "Apply Intelligently", ensure a description is defined in frontmatter - Check **Cursor Settings → Rules** to ensure the rule is enabled - If rule is too large (>500 lines), split into multiple focused rules #### Cline - Check the Rules popover under the chat input field - Toggle rule files on/off as needed using the popover UI #### Claude Code - Use `/config` command to view current configuration - Ask "What instructions are currently active in this project?" #### GitHub Copilot - Select **Configure Chat** (gear icon) > **Chat Instructions** to verify instructions are loaded - Type `/instructions` in the chat input to view active instruction files - Check that `.github/copilot-instructions.md` exists in your workspace root ### File Path Issues on Windows - Use forward slashes `/` in file paths within markdown files - Windows paths with backslashes may not work correctly --- ## Version Control Recommendations **Commit to repository:** ```gitignore # These should be version controlled CLAUDE.md AGENTS.md .amazonq/rules/ .amazonq/aws-aidlc-rule-details/ .kiro/steering/ .kiro/aws-aidlc-rule-details/ .cursor/rules/ .clinerules/ .github/copilot-instructions.md .aidlc-rule-details/ ``` **Optional - Add to `.gitignore` (if needed):** ```gitignore # Local-only settings .claude/settings.local.json ``` --- ## Generated aidlc-docs/ Reference For the complete reference of all documentation artifacts generated by the AI-DLC workflow, see [docs/GENERATED_DOCS_REFERENCE.md](docs/GENERATED_DOCS_REFERENCE.md). --- ## Experimental: AI-Assisted Setup (Release Download) > 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. > > **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. Paste this prompt into your AI agent: ```text Set up AI-DLC in this project by doing the following: 1. Download the latest AI-DLC release: - Use the GitHub API to find the latest release asset URL: curl -sL https://api.github.com/repos/awslabs/aidlc-workflows/releases/latest \ | grep -o '"browser_download_url": *"[^"]*"' \ | head -1 \ | cut -d'"' -f4 - Download the zip from that URL to /tmp/aidlc-rules.zip - Extract it: unzip -o /tmp/aidlc-rules.zip -d /tmp/aidlc-release - Copy the aidlc-rules/ folder from the extracted contents into .aidlc at the project root - Clean up: rm -rf /tmp/aidlc-rules.zip /tmp/aidlc-release 2. Create the appropriate rules/steering file for your IDE using the options below. Pick the one that matches the agent you are running in: - Kiro IDE or Kiro CLI → create `.kiro/steering/ai-dlc.md` - Amazon Q Developer → create `.amazonq/rules/ai-dlc.md` - Antigravity → create `.agent/rules/ai-dlc.md` - Cursor → create `.cursor/rules/ai-dlc.mdc` with frontmatter: --- description: "AI-DLC workflow" alwaysApply: true --- - Cline → create `.clinerules/ai-dlc.md` - Claude Code → create `CLAUDE.md` - GitHub Copilot → create `.github/copilot-instructions.md` - Any other agent → create `AGENTS.md` 3. The file content should be: When the user invokes AI-DLC, read and follow `.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md` to start the workflow. 4. Add `.aidlc` to `.gitignore` unless I explicitly ask you not to. 5. Confirm what file you created and that `.aidlc` is gitignored. ``` The agent will download the latest release, create the correct config file for your IDE, and gitignore the `.aidlc` directory automatically. **Updating AI-DLC** — Re-run the prompt above. The agent will download the latest release and overwrite the existing `.aidlc/` folder. --- ## Additional Resources <!-- TODO: Replace this Amplify URL with a permanent/stable URL when available --> | Resource | Link | | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | AI-DLC Method Definition Paper | [Paper](https://prod.d13rzhkk8cj2z0.amplifyapp.com/) | | AI-DLC Methodology Blog | [AWS Blog](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/) | | AI-DLC Open-source Launch Blog | [AWS Blog](https://aws.amazon.com/blogs/devops/open-sourcing-adaptive-workflows-for-ai-driven-development-life-cycle-ai-dlc/) | | AI-DLC Example Walkthrough Blog | [AWS Blog](https://aws.amazon.com/blogs/devops/building-with-ai-dlc-using-amazon-q-developer/) | | Amazon Q Developer Documentation | [Docs](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/q-in-IDE.html) | | Kiro CLI Documentation | [Docs](https://kiro.dev/docs/cli/steering/) | | Cursor Rules Documentation | [Docs](https://cursor.com/docs/context/rules) | | Claude Code Documentation | [GitHub](https://github.com/anthropics/claude-code) | | GitHub Copilot Documentation | [Docs](https://docs.github.com/en/copilot) | | Working with AI-DLC (interaction patterns and tips) | [docs/WORKING-WITH-AIDLC.md](docs/WORKING-WITH-AIDLC.md) | | Contributing Guidelines | [CONTRIBUTING.md](CONTRIBUTING.md) | | Code of Conduct | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | --- ## Contributing See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. ## License This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file.