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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,18 @@ AI-DLC is an intelligent software development workflow that adapts to your needs

## Quick Start

### Option A: Interactive Installer (Recommended)

If you have Node.js 18+ installed, run the following in your project directory:

```bash
npx aidlc-install
```

This will auto-detect your coding agents and interactively install the rules to the correct paths. See [CLI Installer](cli/README.md) for details and CI usage.

### Option B: Manual Setup

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:
- `aws-aidlc-rules/` — the core AI-DLC workflow rules
Expand Down
3 changes: 3 additions & 0 deletions cli/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
*.tgz
aidlc-rules/
67 changes: 67 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# aidlc-install

Interactive CLI installer for [AI-DLC](https://github.com/awslabs/aidlc-workflows) rules across coding agents.

## Usage

```bash
npx aidlc-install
```

Interactively select which agents to install AI-DLC rules for:

```
┌ AI-DLC Rules Installer
◇ Agent Detection
│ Detected: Kiro, Claude Code
◆ Select agents to install rules for:
│ ● Kiro .kiro/steering/ (detected)
│ ○ Amazon Q Developer .amazonq/rules/
│ ○ Cursor IDE .cursor/rules/ai-dlc-workflow.mdc
│ ○ Cline .clinerules/
│ ● Claude Code CLAUDE.md (detected)
│ ○ GitHub Copilot .github/copilot-instructions.md
◆ Installation mode:
│ ● Symlink (recommended)
│ ○ Copy
└ Done! Restart your agent to load the new rules.
```

## Supported Agents

| Agent | Install Path |
|-------|-------------|
| Kiro | `.kiro/steering/aws-aidlc-rules` |
| Amazon Q Developer | `.amazonq/rules/aws-aidlc-rules` |
| Cursor IDE | `.cursor/rules/ai-dlc-workflow.mdc` |
| Cline | `.clinerules/core-workflow.md` |
| Claude Code | `CLAUDE.md` |
| GitHub Copilot | `.github/copilot-instructions.md` |
Comment on lines +36 to +43
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The markdown table under "Supported Agents" uses || at the start of each row, which renders as an extra empty column in many renderers. Use a single leading | per row to form a standard 2-column table.

Copilot uses AI. Check for mistakes.
Comment on lines +36 to +43
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The "Supported Agents" table lists only the primary rules path, but the installer also writes the rule-details directory (e.g., .aidlc-rule-details/ or .kiro/aws-aidlc-rule-details). Consider documenting both paths per agent here so users know what files/folders will be created/overwritten.

Suggested change
| Agent | Install Path |
|-------|-------------|
| Kiro | `.kiro/steering/aws-aidlc-rules` |
| Amazon Q Developer | `.amazonq/rules/aws-aidlc-rules` |
| Cursor IDE | `.cursor/rules/ai-dlc-workflow.mdc` |
| Cline | `.clinerules/core-workflow.md` |
| Claude Code | `CLAUDE.md` |
| GitHub Copilot | `.github/copilot-instructions.md` |
| Agent | Rules Path | Rule Details Path |
|-------|------------|-------------------|
| Kiro | `.kiro/steering/aws-aidlc-rules` | `.kiro/aws-aidlc-rule-details/` |
| Amazon Q Developer | `.amazonq/rules/aws-aidlc-rules` | `.aidlc-rule-details/` |
| Cursor IDE | `.cursor/rules/ai-dlc-workflow.mdc` | `.aidlc-rule-details/` |
| Cline | `.clinerules/core-workflow.md` | `.aidlc-rule-details/` |
| Claude Code | `CLAUDE.md` | `.aidlc-rule-details/` |
| GitHub Copilot | `.github/copilot-instructions.md` | `.aidlc-rule-details/` |

Copilot uses AI. Check for mistakes.

Comment on lines +36 to +44
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The “Supported Agents” table omits the rule-details destinations that are also installed (e.g. .aidlc-rule-details/, .kiro/aws-aidlc-rule-details, .amazonq/aws-aidlc-rule-details). Update this section to include both installed paths so the docs match actual installer behavior.

Suggested change
| Agent | Install Path |
|-------|-------------|
| Kiro | `.kiro/steering/aws-aidlc-rules` |
| Amazon Q Developer | `.amazonq/rules/aws-aidlc-rules` |
| Cursor IDE | `.cursor/rules/ai-dlc-workflow.mdc` |
| Cline | `.clinerules/core-workflow.md` |
| Claude Code | `CLAUDE.md` |
| GitHub Copilot | `.github/copilot-instructions.md` |
| Agent | Install Path(s) |
|-------|-----------------|
| Kiro | `.kiro/steering/aws-aidlc-rules`, `.kiro/aws-aidlc-rule-details` |
| Amazon Q Developer | `.amazonq/rules/aws-aidlc-rules`, `.amazonq/aws-aidlc-rule-details` |
| Cursor IDE | `.cursor/rules/ai-dlc-workflow.mdc` |
| Cline | `.clinerules/core-workflow.md` |
| Claude Code | `CLAUDE.md` |
| GitHub Copilot | `.github/copilot-instructions.md` |
The installer also creates a workspace-level `.aidlc-rule-details/` directory that contains shared rule details, alongside the per-agent rule-details directories such as `.kiro/aws-aidlc-rule-details` and `.amazonq/aws-aidlc-rule-details`.

Copilot uses AI. Check for mistakes.
## Commands

```bash
npx aidlc-install # Install rules (interactive)
npx aidlc-install remove # Uninstall rules
npx aidlc-install list # Show installed rules
```

## CI / Non-Interactive

```bash
npx aidlc-install --agent kiro --agent claude --copy -y
```

| Flag | Description |
|------|-------------|
| `-a, --agent <name>` | Target specific agents (repeatable) |
| `-y, --yes` | Skip prompts |
| `--copy` | Copy files instead of symlink |

## License

MIT-0
55 changes: 55 additions & 0 deletions cli/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions cli/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "@inariku/aidlc-install",
"version": "0.1.1",
"description": "Interactive installer for AI-DLC rules across coding agents",
"license": "MIT-0",
"bin": {
"aidlc-install": "src/index.mjs"
},
"type": "module",
"files": [
"src/",
"aidlc-rules/",
"README.md"
],
"scripts": {
"prepack": "node -e \"require('fs').cpSync('../aidlc-rules','aidlc-rules',{recursive:true})\"",
"postpack": "node -e \"require('fs').rmSync('aidlc-rules',{recursive:true,force:true})\""
},
"dependencies": {
"@clack/prompts": "^0.11.0"
},
"engines": {
"node": ">=18"
}
}
Loading
Loading