|
| 1 | +# AI-DLC Claude Code Plugin |
| 2 | + |
| 3 | +AI-Driven Development Life Cycle (AI-DLC) packaged as a Claude Code plugin. |
| 4 | +Provides an adaptive three-phase software development workflow (Inception, |
| 5 | +Construction, Operations) driven by an orchestrator agent, phase-specific slash |
| 6 | +commands, and progressive-disclosure skills. |
| 7 | + |
| 8 | +**Version**: 0.1.8 |
| 9 | +**Source of truth**: `aidlc-rules/` in this repository |
| 10 | +**Generator**: `scripts/build-cc-plugin.py` |
| 11 | + |
| 12 | +> This directory is **generated**. Do not edit files here directly — edit the |
| 13 | +> canonical sources in `aidlc-rules/` and run the generator. CI enforces sync. |
| 14 | +
|
| 15 | +## What You Get |
| 16 | + |
| 17 | +| Component | Purpose | |
| 18 | +| ---------------------------- | ------------------------------------------------------------ | |
| 19 | +| `/aidlc` | Start or resume an AI-DLC workflow | |
| 20 | +| `/aidlc:inception` | Start or resume the Inception phase | |
| 21 | +| `/aidlc:construction` | Start or resume the Construction phase | |
| 22 | +| `/aidlc:operations` | Start or resume the Operations phase (placeholder) | |
| 23 | +| `aidlc-orchestrator` agent | Drives the three-phase workflow, detects phase from state | |
| 24 | +| `aidlc-core-workflow` skill | Master workflow definition | |
| 25 | +| `aidlc-inception` skill | Inception phase rules (workspace detection, requirements, …) | |
| 26 | +| `aidlc-construction` skill | Construction phase rules (design, NFR, code generation, …) | |
| 27 | +| `aidlc-operations` skill | Operations phase rules (placeholder) | |
| 28 | +| `aidlc-common` skill | Cross-cutting rules (terminology, depth, error handling, …) | |
| 29 | +| `aidlc-security-baseline` | Opt-in security extension | |
| 30 | +| `aidlc-property-testing` | Opt-in property-based testing extension | |
| 31 | + |
| 32 | +## Installing |
| 33 | + |
| 34 | +### For Development (Local Path) |
| 35 | + |
| 36 | +Use `--plugin-dir` to load the plugin from a local path for a single session. |
| 37 | +This is the fastest way to iterate on plugin changes without publishing. |
| 38 | + |
| 39 | +```bash |
| 40 | +# From a clone of this repo, at the repo root: |
| 41 | +claude --plugin-dir ./plugins/claude-code-aidlc |
| 42 | +``` |
| 43 | + |
| 44 | +The flag is repeatable for loading multiple plugins side-by-side: |
| 45 | + |
| 46 | +```bash |
| 47 | +claude --plugin-dir ./plugins/claude-code-aidlc --plugin-dir ../other-plugin |
| 48 | +``` |
| 49 | + |
| 50 | +Inside the session, use `/reload-plugins` to pick up changes without |
| 51 | +restarting Claude Code. |
| 52 | + |
| 53 | +### For Persistent Local Install (Development) |
| 54 | + |
| 55 | +Add this repo as a local marketplace, then install the plugin from it: |
| 56 | + |
| 57 | +```bash |
| 58 | +# Register the repo as a marketplace (persists across sessions) |
| 59 | +claude plugin marketplace add /absolute/path/to/aws-aidlc-workflows |
| 60 | + |
| 61 | +# Install the aidlc plugin |
| 62 | +claude plugin install aidlc |
| 63 | +``` |
| 64 | + |
| 65 | +Scope the install with `--scope user|project|local` if needed (defaults to |
| 66 | +`user`). |
| 67 | + |
| 68 | +### For End Users (Git Install) |
| 69 | + |
| 70 | +Once published, users install directly from the repository: |
| 71 | + |
| 72 | +```bash |
| 73 | +claude plugin marketplace add https://github.com/awslabs/aidlc-workflows |
| 74 | +claude plugin install aidlc |
| 75 | +``` |
| 76 | + |
| 77 | +## Using the Plugin |
| 78 | + |
| 79 | +After installation, start or resume a workflow: |
| 80 | + |
| 81 | +```text |
| 82 | +/aidlc |
| 83 | +``` |
| 84 | + |
| 85 | +With no argument, the orchestrator detects existing AIDLC state in the |
| 86 | +workspace (via `aidlc-docs/aidlc-state.md`) and either resumes or shows the |
| 87 | +welcome message. You can also provide an initial request: |
| 88 | + |
| 89 | +```text |
| 90 | +/aidlc build a REST API for order management |
| 91 | +``` |
| 92 | + |
| 93 | +Target a specific phase: |
| 94 | + |
| 95 | +```text |
| 96 | +/aidlc:inception |
| 97 | +/aidlc:construction |
| 98 | +/aidlc:operations |
| 99 | +``` |
| 100 | + |
| 101 | +## How It Works |
| 102 | + |
| 103 | +1. The orchestrator agent detects current phase from workspace state |
| 104 | +2. It loads the appropriate phase skill (`aidlc-inception`, |
| 105 | + `aidlc-construction`, or `aidlc-operations`) on demand |
| 106 | +3. Each skill's `references/` directory contains the rule-detail files — |
| 107 | + loaded lazily as the workflow progresses |
| 108 | +4. The `aidlc-common` skill provides cross-cutting rules (terminology, |
| 109 | + question formatting, error handling) referenced throughout |
| 110 | +5. Extension skills (`aidlc-security-baseline`, `aidlc-property-testing`) are |
| 111 | + loaded only when the user opts in during Requirements Analysis |
| 112 | + |
| 113 | +All rule content is bundled with the plugin — no workspace file copies |
| 114 | +required. |
| 115 | + |
| 116 | +## Contributing |
| 117 | + |
| 118 | +Do not edit files in this directory directly. Edit the canonical source in |
| 119 | +`aidlc-rules/` at the repository root, then regenerate: |
| 120 | + |
| 121 | +```bash |
| 122 | +python scripts/build-cc-plugin.py |
| 123 | +``` |
| 124 | + |
| 125 | +CI (`plugin-sync` job) runs the generator on every PR and fails if the |
| 126 | +committed output drifts from the source. |
| 127 | + |
| 128 | +## Structure |
| 129 | + |
| 130 | +```text |
| 131 | +plugins/claude-code-aidlc/ |
| 132 | +├── .claude-plugin/ |
| 133 | +│ └── plugin.json # Plugin manifest (name, version, metadata) |
| 134 | +├── agents/ |
| 135 | +│ └── aidlc-orchestrator.md # Orchestrator agent definition |
| 136 | +├── commands/ |
| 137 | +│ ├── aidlc.md # /aidlc entry command |
| 138 | +│ ├── aidlc-inception.md # /aidlc:inception |
| 139 | +│ ├── aidlc-construction.md # /aidlc:construction |
| 140 | +│ └── aidlc-operations.md # /aidlc:operations |
| 141 | +└── skills/ |
| 142 | + ├── aidlc-core-workflow/ |
| 143 | + ├── aidlc-inception/ |
| 144 | + ├── aidlc-construction/ |
| 145 | + ├── aidlc-operations/ |
| 146 | + ├── aidlc-common/ |
| 147 | + ├── aidlc-security-baseline/ |
| 148 | + └── aidlc-property-testing/ |
| 149 | +``` |
| 150 | + |
| 151 | +Each skill contains a `SKILL.md` and a `references/` subdirectory with the |
| 152 | +bundled rule-detail files. |
| 153 | + |
| 154 | +## License |
| 155 | + |
| 156 | +Apache-2.0 — see [LICENSE](../../LICENSE). |
0 commit comments