Skip to content
Open
Show file tree
Hide file tree
Changes from 12 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
1 change: 0 additions & 1 deletion CHANGELOG.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove changes to this file

Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,3 @@ All notable changes to this project will be documented in this file.
### Features

- add Kiro CLI support and multi-platform architecture

21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,34 @@ Before contributing, familiarize yourself with our [tenets](README.md#tenets).

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

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

### Directory Structure — Do Not Rename or Move

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.

```
aidlc-rules/
├── aws-aidlc-rules/ # Core workflow entry point
│ └── core-workflow.md
└── aws-aidlc-rule-details/ # Detailed rules referenced by the workflow
├── common/
├── inception/
├── construction/
├── extensions/
└── operations/
```

### Rule Structure

Rules are organized by phase:
Rules are organized by phase inside `aws-aidlc-rule-details/`:
- `common/` - Shared guidance across all phases
- `inception/` - Planning and architecture rules
- `construction/` - Design and implementation rules
- `operations/` - Deployment and monitoring rules
- `extensions/` - Optional cross-cutting constraint rules

### Testing Changes

Expand Down
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ AI-DLC is an intelligent software development workflow that adapts to your needs

## Table of Contents

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

---

## Quick Start
## Common

1. Download the latest release zip from the [Releases page](../../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:
Expand All @@ -34,6 +35,59 @@ AI-DLC is an intelligent software development workflow that adapts to your needs

---

### 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:

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

---

## Platform-Specific Setup

- [Kiro](#kiro)
Expand Down
9 changes: 5 additions & 4 deletions aidlc-rules/aws-aidlc-rules/core-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ The AI model intelligently assesses what stages are needed based on:
4. Risk and impact assessment

## MANDATORY: Rule Details Loading
**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:
- `.aidlc-rule-details/` (Cursor, Cline, Claude Code, GitHub Copilot)
- `.kiro/aws-aidlc-rule-details/` (Kiro IDE and CLI)
- `.amazonq/aws-aidlc-rule-details/` (Amazon Q Developer)
**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:
- `.aidlc/aidlc-rules/aws-aidlc-rule-details/` (typical with AI-assisted setup)
- `.aidlc-rule-details/` (typical with Cursor, Cline, Claude Code, GitHub Copilot)
- `.kiro/aws-aidlc-rule-details/` (typical with Kiro IDE and CLI)
- `.amazonq/aws-aidlc-rule-details/` (typical with Amazon Q Developer)

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.

Expand Down
Loading