Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 88 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Three-Phase Adaptive Workflow](#three-phase-adaptive-workflow)
- [Key Features](#key-features)
- [Extensions](#extensions)
- [Supporting Tools](#supporting-tools)
- [Tenets](#tenets)
- [Prerequisites](#prerequisites)
- [Troubleshooting](#troubleshooting)
Expand Down Expand Up @@ -44,8 +45,6 @@
- [Cline](#cline)
- [Claude Code](#claude-code)
- [GitHub Copilot](#github-copilot)
- [OpenAI Codex](#openai-codex)
- [Other Agents](#other-agents)

---

Expand Down Expand Up @@ -672,6 +671,76 @@

---

## 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/`.

Check notice

Code scanning / Semgrep OSS

Semgrep Finding: ai.generic.detect-generic-ai-anthprop.detect-generic-ai-anthprop Note

Possibly found usage of AI: Anthropic

**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.
Expand Down Expand Up @@ -717,17 +786,10 @@

### Platform-Specific Issues

#### Kiro

- Use `/context show` in Kiro CLI to verify rules are loaded
- Check `.kiro/steering/` directory structure
- Note: Kiro uses `aws-aidlc-rule-details` (not `.aidlc-rule-details/`) under the `.kiro/` directory

#### Amazon Q Developer
#### Amazon Q Developer / Kiro

- Check `.amazonq/rules/` directory structure
- Verify rules are listed in the Amazon Q Chat Rules panel
- Note: Amazon Q uses `aws-aidlc-rule-details` (not `.aidlc-rule-details/`) under the `.amazonq/` directory
- Use `/context show` to verify rules are loaded
- Check `.amazonq/rules/` or `.kiro/steering/` directory structure

#### Cursor

Expand Down Expand Up @@ -793,54 +855,20 @@

## 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.
| 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) |

---

Expand Down
44 changes: 44 additions & 0 deletions scripts/aidlc-designreview/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Python
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
.venv/
venv/
ENV/
env/
*.egg-info/
dist/
build/

# Testing
.pytest_cache/
.coverage
htmlcov/
.mypy_cache/
.tox/

# IDE
.vscode/
.idea/
*.swp
*.swo

# Logs
logs/
*.log

# Generated reports
reports/
*.html

# OS
.DS_Store
Thumbs.db

# AIDLC artifacts (development only)
aidlc-docs/
input_documents/
test_data/
security-reports/
Loading