π« Toolkit to help you get started with SDD or any other process!
feat(agent): Added Amazon Q Developer CLI Integration
Brian Andersonde1db34b084a
diff --git a/.github/workflows/scripts/create-github-release.sh b/.github/workflows/scripts/create-github-release.shindex 0257520f5..26b08880a 100644--- a/.github/workflows/scripts/create-github-release.sh+++ b/.github/workflows/scripts/create-github-release.sh@@ -38,5 +38,7 @@ gh release create "$VERSION" \.genreleases/spec-kit-template-auggie-ps-"$VERSION".zip \.genreleases/spec-kit-template-roo-sh-"$VERSION".zip \.genreleases/spec-kit-template-roo-ps-"$VERSION".zip \+ .genreleases/spec-kit-template-q-sh-"$VERSION".zip \+ .genreleases/spec-kit-template-q-ps-"$VERSION".zip \--title "Spec Kit Templates - $VERSION_NO_V" \--notes-file release_notes.md\ No newline at end of filediff --git a/.github/workflows/scripts/create-release-packages.sh b/.github/workflows/scripts/create-release-packages.shindex 1a12e5582..82601c600 100644--- a/.github/workflows/scripts/create-release-packages.sh+++ b/.github/workflows/scripts/create-release-packages.sh@@ -172,13 +172,16 @@ build_variant() {roo)mkdir -p "$base_dir/.roo/commands"generate_commands roo md "\$ARGUMENTS" "$base_dir/.roo/commands" "$script" ;;+ q)+ mkdir -p "$base_dir/.amazonq/prompts"+ generate_commands q md "\$ARGUMENTS" "$base_dir/.amazonq/prompts" "$script" ;;esac( cd "$base_dir" && zip -r "../spec-kit-template-${agent}-${script}-${NEW_VERSION}.zip" . )echo "Created $GENRELEASES_DIR/spec-kit-template-${agent}-${script}-${NEW_VERSION}.zip"}# Determine agent list-ALL_AGENTS=(claude gemini copilot cursor qwen opencode windsurf codex kilocode auggie roo)+ALL_AGENTS=(claude gemini copilot cursor qwen opencode windsurf codex kilocode auggie roo q)ALL_SCRIPTS=(sh ps)diff --git a/AGENTS.md b/AGENTS.mdindex 59b995668..6cae67031 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -38,6 +38,8 @@ Specify supports multiple AI agents by generating agent-specific command files a| **Qwen Code** | `.qwen/commands/` | TOML | `qwen` | Alibaba's Qwen Code CLI || **opencode** | `.opencode/command/` | Markdown | `opencode` | opencode CLI || **Windsurf** | `.windsurf/workflows/` | Markdown | N/A (IDE-based) | Windsurf IDE workflows |+| **Amazon Q Developer CLI** | `.amazonq/prompts/` | Markdown | `q` | Amazon Q Developer CLI |+### Step-by-Step Integration Guide@@ -55,7 +57,8 @@ AI_CHOICES = {"cursor": "Cursor","qwen": "Qwen Code","opencode": "opencode",- "windsurf": "Windsurf" # Add new agent here+ "windsurf": "Windsurf",+ "q": "Amazon Q Developer CLI" # Add new agent here}```@@ -69,10 +72,11 @@ agent_folder_map = {"qwen": ".qwen/","opencode": ".opencode/","codex": ".codex/",- "windsurf": ".windsurf/", # Add new agent folder here+ "windsurf": ".windsurf/","kilocode": ".kilocode/","auggie": ".auggie/",- "copilot": ".github/"+ "copilot": ".github/",+ "q": ".amazonq/" # Add new agent folder here}```@@ -99,7 +103,7 @@ Modify `.github/workflows/scripts/create-release-packages.sh`:##### Add to ALL_AGENTS array:```bash-ALL_AGENTS=(claude gemini copilot cursor qwen opencode windsurf)+ALL_AGENTS=(claude gemini copilot cursor qwen opencode windsurf q)```##### Add case statement for directory structure:@@ -206,7 +210,7 @@ Work within integrated development environments:## Command File Formats### Markdown Format-Used by: Claude, Cursor, opencode, Windsurf+Used by: Claude, Cursor, opencode, Windsurf, Amazon Q Developer```markdown---diff --git a/README.md b/README.mdindex b4e91c377..ef53ee56d 100644--- a/README.md+++ b/README.md@@ -133,6 +133,7 @@ Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.c| [Kilo Code](https://github.com/Kilo-Org/kilocode) | β | || [Auggie CLI](https://docs.augmentcode.com/cli/overview) | β | || [Roo Code](https://roocode.com/) | β | |+| [Amazon Q Developer CLI](https://aws.amazon.com/developer/learning/q-developer-cli/) | β | || [Codex CLI](https://github.com/openai/codex) | β οΈ | Codex [does not support](https://github.com/openai/codex/issues/2890) custom arguments for slash commands. |## π§ Specify CLI Reference@@ -151,7 +152,7 @@ The `specify` command supports the following options:| Argument/Option | Type | Description ||------------------------|----------|------------------------------------------------------------------------------|| `<project-name>` | Argument | Name for your new project directory (optional if using `--here`, or use `.` for current directory) |-| `--ai` | Option | AI assistant to use: `claude`, `gemini`, `copilot`, `cursor`, `qwen`, `opencode`, `codex`, `windsurf`, `kilocode`, `auggie`, or `roo` |+| `--ai` | Option | AI assistant to use: `claude`, `gemini`, `copilot`, `cursor`, `qwen`, `opencode`, `codex`, `windsurf`, `kilocode`, `auggie`, `roo`, or `q` || `--script` | Option | Script variant to use: `sh` (bash/zsh) or `ps` (PowerShell) || `--ignore-agent-tools` | Flag | Skip checks for AI agent tools like Claude Code || `--no-git` | Flag | Skip git repository initialization |@@ -268,7 +269,7 @@ Our research and experimentation focus on:## π§ Prerequisites- **Linux/macOS** (or WSL2 on Windows)-- AI coding agent: [Claude Code](https://www.anthropic.com/claude-code), [GitHub Copilot](https://code.visualstudio.com/), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Cursor](https://cursor.sh/), [Qwen CLI](https://github.com/QwenLM/qwen-code), [opencode](https://opencode.ai/), [Codex CLI](https://github.com/openai/codex), or [Windsurf](https://windsurf.com/)+- AI coding agent: [Claude Code](https://www.anthropic.com/claude-code), [GitHub Copilot](https://code.visualstudio.com/), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Cursor](https://cursor.sh/), [Qwen CLI](https://github.com/QwenLM/qwen-code), [opencode](https://opencode.ai/), [Codex CLI](https://github.com/openai/codex), [Windsurf](https://windsurf.com/), or [Amazon Q Developer CLI](https://aws.amazon.com/developer/learning/q-developer-cli/)- [uv](https://docs.astral.sh/uv/) for package management- [Python 3.11+](https://www.python.org/downloads/)- [Git](https://git-scm.com/downloads)@@ -318,6 +319,7 @@ specify init <project_name> --ai qwenspecify init <project_name> --ai opencodespecify init <project_name> --ai codexspecify init <project_name> --ai windsurf+specify init <project_name> --ai q# Or in current directory:specify init . --ai claudespecify init . --ai codex@@ -330,7 +332,7 @@ specify init . --force --ai claudespecify init --here --force --ai claude```-The CLI will check if you have Claude Code, Gemini CLI, Cursor CLI, Qwen CLI, opencode, or Codex CLI installed. If you do not, or you prefer to get the templates without checking for the right tools, use `--ignore-agent-tools` with your command:+The CLI will check if you have Claude Code, Gemini CLI, Cursor CLI, Qwen CLI, opencode, Codex CLI, or Amazon Q Developer CLI installed. If you do not, or you prefer to get the templates without checking for the right tools, use `--ignore-agent-tools` with your command:```bashspecify init <project_name> --ai claude --ignore-agent-toolsdiff --git a/scripts/bash/update-agent-context.sh b/scripts/bash/update-agent-context.shindex d3cc422ed..036d6b21f 100644--- a/scripts/bash/update-agent-context.sh+++ b/scripts/bash/update-agent-context.sh@@ -30,12 +30,12 @@## 5. Multi-Agent Support# - Handles agent-specific file paths and naming conventions-# - Supports: Claude, Gemini, Copilot, Cursor, Qwen, opencode, Codex, Windsurf+# - Supports: Claude, Gemini, Copilot, Cursor, Qwen, opencode, Codex, Windsurf, Kilo Code, Auggie CLI, or Amazon Q Developer CLI# - Can update single agents or all existing agent files# - Creates default Claude file if no agent files exist## Usage: ./update-agent-context.sh [agent_type]-# Agent types: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf+# Agent types: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|q# Leave empty to update all existing agent filesset -e@@ -69,6 +69,7 @@ WINDSURF_FILE="$REPO_ROOT/.windsurf/rules/specify-rules.md"KILOCODE_FILE="$REPO_ROOT/.kilocode/rules/specify-rules.md"AUGGIE_FILE="$REPO_ROOT/.augment/rules/specify-rules.md"ROO_FILE="$REPO_ROOT/.roo/rules/specify-rules.md"+Q_FILE="$REPO_ROOT/AGENTS.md"# Template fileTEMPLATE_FILE="$REPO_ROOT/.specify/templates/agent-file-template.md"@@ -580,9 +581,12 @@ update_specific_agent() {roo)update_agent_file "$ROO_FILE" "Roo Code";;+ q)+ update_agent_file "$Q_FILE" "Amazon Q Developer CLI"+ ;;*)log_error "Unknown agent type '$agent_type'"- log_error "Expected: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo"+ log_error "Expected: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo|q"exit 1;;esac@@ -641,6 +645,11 @@ update_all_existing_agents() {update_agent_file "$ROO_FILE" "Roo Code"found_agent=truefi++ if [[ -f "$Q_FILE" ]]; then+ update_agent_file "$Q_FILE" "Amazon Q Developer CLI"+ found_agent=true+ fi# If no agent files exist, create a default Claude fileif [[ "$found_agent" == false ]]; then@@ -665,7 +674,7 @@ print_summary() {fiecho- log_info "Usage: $0 [claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo]"+ log_info "Usage: $0 [claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|q]"}#==============================================================================diff --git a/scripts/powershell/update-agent-context.ps1 b/scripts/powershell/update-agent-context.ps1index 8f4830a95..a182c6d28 100644--- a/scripts/powershell/update-agent-context.ps1+++ b/scripts/powershell/update-agent-context.ps1@@ -9,7 +9,7 @@ Mirrors the behavior of scripts/bash/update-agent-context.sh:2. Plan Data Extraction3. Agent File Management (create from template or update existing)4. Content Generation (technology stack, recent changes, timestamp)- 5. Multi-Agent Support (claude, gemini, copilot, cursor, qwen, opencode, codex, windsurf)+ 5. Multi-Agent Support (claude, gemini, copilot, cursor, qwen, opencode, codex, windsurf, kilocode, auggie, roo, q).PARAMETER AgentTypeOptional agent key to update a single agent. If omitted, updates all existing agent files (creating a default Claude file if none exist).@@ -25,7 +25,7 @@ Relies on common helper functions in common.ps1#>param([Parameter(Position=0)]- [ValidateSet('claude','gemini','copilot','cursor','qwen','opencode','codex','windsurf','kilocode','auggie','roo')]+ [ValidateSet('claude','gemini','copilot','cursor','qwen','opencode','codex','windsurf','kilocode','auggie','roo','q')][string]$AgentType)@@ -54,6 +54,7 @@ $WINDSURF_FILE = Join-Path $REPO_ROOT '.windsurf/rules/specify-rules.md'$KILOCODE_FILE = Join-Path $REPO_ROOT '.kilocode/rules/specify-rules.md'$AUGGIE_FILE = Join-Path $REPO_ROOT '.augment/rules/specify-rules.md'$ROO_FILE = Join-Path $REPO_ROOT '.roo/rules/specify-rules.md'+$Q_FILE = Join-Path $REPO_ROOT 'AGENTS.md'$TEMPLATE_FILE = Join-Path $REPO_ROOT '.specify/templates/agent-file-template.md'@@ -376,7 +377,8 @@ function Update-SpecificAgent {'kilocode' { Update-AgentFile -TargetFile $KILOCODE_FILE -AgentName 'Kilo Code' }'auggie' { Update-AgentFile -TargetFile $AUGGIE_FILE -AgentName 'Auggie CLI' }'roo' { Update-AgentFile -TargetFile $ROO_FILE -AgentName 'Roo Code' }- default { Write-Err "Unknown agent type '$Type'"; Write-Err 'Expected: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo'; return $false }+ 'q' { Update-AgentFile -TargetFile $Q_FILE -AgentName 'Amazon Q Developer CLI' }+ default { Write-Err "Unknown agent type '$Type'"; Write-Err 'Expected: claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo|q'; return $false }}}@@ -393,6 +395,7 @@ function Update-AllExistingAgents {if (Test-Path $KILOCODE_FILE) { if (-not (Update-AgentFile -TargetFile $KILOCODE_FILE -AgentName 'Kilo Code')) { $ok = $false }; $found = $true }if (Test-Path $AUGGIE_FILE) { if (-not (Update-AgentFile -TargetFile $AUGGIE_FILE -AgentName 'Auggie CLI')) { $ok = $false }; $found = $true }if (Test-Path $ROO_FILE) { if (-not (Update-AgentFile -TargetFile $ROO_FILE -AgentName 'Roo Code')) { $ok = $false }; $found = $true }+ if (Test-Path $Q_FILE) { if (-not (Update-AgentFile -TargetFile $Q_FILE -AgentName 'Amazon Q Developer CLI')) { $ok = $false }; $found = $true }if (-not $found) {Write-Info 'No existing agent files found, creating default Claude file...'if (-not (Update-AgentFile -TargetFile $CLAUDE_FILE -AgentName 'Claude Code')) { $ok = $false }@@ -407,7 +410,7 @@ function Print-Summary {if ($NEW_FRAMEWORK) { Write-Host " - Added framework: $NEW_FRAMEWORK" }if ($NEW_DB -and $NEW_DB -ne 'N/A') { Write-Host " - Added database: $NEW_DB" }Write-Host ''- Write-Info 'Usage: ./update-agent-context.ps1 [-AgentType claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo]'+ Write-Info 'Usage: ./update-agent-context.ps1 [-AgentType claude|gemini|copilot|cursor|qwen|opencode|codex|windsurf|kilocode|auggie|roo|q]'}function Main {diff --git a/src/specify_cli/__init__.py b/src/specify_cli/__init__.pyindex a5be99d74..1ade24727 100644--- a/src/specify_cli/__init__.py+++ b/src/specify_cli/__init__.py@@ -77,6 +77,7 @@ AI_CHOICES = {"kilocode": "Kilo Code","auggie": "Auggie CLI","roo": "Roo Code",+ "q": "Amazon Q Developer CLI",}# Add script type choicesSCRIPT_TYPE_CHOICES = {"sh": "POSIX Shell (bash/zsh)", "ps": "PowerShell"}@@ -750,7 +751,7 @@ def ensure_executable_scripts(project_path: Path, tracker: StepTracker | None =@app.command()def init(project_name: str = typer.Argument(None, help="Name for your new project directory (optional if using --here, or use '.' for current directory)"),- ai_assistant: str = typer.Option(None, "--ai", help="AI assistant to use: claude, gemini, copilot, cursor, qwen, opencode, codex, windsurf, kilocode, or auggie"),+ ai_assistant: str = typer.Option(None, "--ai", help="AI assistant to use: claude, gemini, copilot, cursor, qwen, opencode, codex, windsurf, kilocode, auggie or q"),script_type: str = typer.Option(None, "--script", help="Script type to use: sh or ps"),ignore_agent_tools: bool = typer.Option(False, "--ignore-agent-tools", help="Skip checks for AI agent tools like Claude Code"),no_git: bool = typer.Option(False, "--no-git", help="Skip git repository initialization"),@@ -765,8 +766,8 @@ def init(This command will:1. Check that required tools are installed (git is optional)- 2. Let you choose your AI assistant (Claude Code, Gemini CLI, GitHub Copilot, Cursor, Qwen Code, opencode, Codex CLI, Windsurf, Kilo Code, or Auggie CLI)- 3. Download the appropriate template from GitHub+ 2. Let you choose your AI assistant (Claude Code, Gemini CLI, GitHub Copilot, Cursor, Qwen Code, opencode, Codex CLI, Windsurf, Kilo Code, Auggie CLI, or Amazon Q Developer CLI)+ 3. Download the appropriate template from GitHub (or use local release if --local or --local-release is specified)4. Extract the template to a new project directory or current directory5. Initialize a fresh git repository (if not --no-git and no existing repo)6. Optionally set up AI assistant commands@@ -782,6 +783,7 @@ def init(specify init my-project --ai codexspecify init my-project --ai windsurfspecify init my-project --ai auggie+ specify init my-project --ai qspecify init --ignore-agent-tools my-projectspecify init . --ai claude # Initialize in current directoryspecify init . # Initialize in current directory (interactive AI selection)@@ -906,6 +908,10 @@ def init(if not check_tool("auggie", "https://docs.augmentcode.com/cli/setup-auggie/install-auggie-cli"):install_url = "https://docs.augmentcode.com/cli/setup-auggie/install-auggie-cli"agent_tool_missing = True+ elif selected_ai == "q":+ if not check_tool("q", "https://github.com/aws/amazon-q-developer-cli"):+ install_url = "https://aws.amazon.com/developer/learning/q-developer-cli/"+ agent_tool_missing = True# GitHub Copilot and Cursor checks are not needed as they're typically available in supported IDEsif agent_tool_missing:@@ -1030,7 +1036,8 @@ def init("kilocode": ".kilocode/","auggie": ".augment/","copilot": ".github/",- "roo": ".roo/"+ "roo": ".roo/",+ "q": ".amazonq/"}if selected_ai in agent_folder_map:@@ -1119,6 +1126,7 @@ def check():tracker.add("opencode", "opencode")tracker.add("codex", "Codex CLI")tracker.add("auggie", "Auggie CLI")+ tracker.add("q", "Amazon Q Developer CLI")git_ok = check_tool_for_tracker("git", tracker)claude_ok = check_tool_for_tracker("claude", tracker)@@ -1132,6 +1140,7 @@ def check():opencode_ok = check_tool_for_tracker("opencode", tracker)codex_ok = check_tool_for_tracker("codex", tracker)auggie_ok = check_tool_for_tracker("auggie", tracker)+ q_ok = check_tool_for_tracker("q", tracker)console.print(tracker.render())@@ -1139,7 +1148,7 @@ def check():if not git_ok:console.print("[dim]Tip: Install git for repository management[/dim]")- if not (claude_ok or gemini_ok or cursor_ok or qwen_ok or windsurf_ok or kilocode_ok or opencode_ok or codex_ok or auggie_ok):+ if not (claude_ok or gemini_ok or cursor_ok or qwen_ok or windsurf_ok or kilocode_ok or opencode_ok or codex_ok or auggie_ok or q_ok):console.print("[dim]Tip: Install an AI assistant for the best experience[/dim]")diff --git a/templates/plan-template.md b/templates/plan-template.mdindex 283ffd4b3..5e28b50e0 100644--- a/templates/plan-template.md+++ b/templates/plan-template.md@@ -24,7 +24,7 @@ scripts:β Update Progress Tracking: Initial Constitution Check5. Execute Phase 0 β research.mdβ If NEEDS CLARIFICATION remain: ERROR "Resolve unknowns"-6. Execute Phase 1 β contracts, data-model.md, quickstart.md, agent-specific template file (e.g., `CLAUDE.md` for Claude Code, `.github/copilot-instructions.md` for GitHub Copilot, `GEMINI.md` for Gemini CLI, `QWEN.md` for Qwen Code or `AGENTS.md` for opencode).+6. Execute Phase 1 β contracts, data-model.md, quickstart.md, agent-specific template file (e.g., `CLAUDE.md` for Claude Code, `.github/copilot-instructions.md` for GitHub Copilot, `GEMINI.md` for Gemini CLI, `QWEN.md` for Qwen Code, or `AGENTS.md` for all other agents).7. Re-evaluate Constitution Check sectionβ If new violations: Refactor design, return to Phase 1β Update Progress Tracking: Post-Design Constitution Check