diff --git a/claude-code-full-guide/.claude/commands/execute-prp.md b/.amazonq/commands/execute-prp.md similarity index 96% rename from claude-code-full-guide/.claude/commands/execute-prp.md rename to .amazonq/commands/execute-prp.md index 81fb8ea8ff..0010557310 100644 --- a/claude-code-full-guide/.claude/commands/execute-prp.md +++ b/.amazonq/commands/execute-prp.md @@ -1,6 +1,6 @@ # Execute BASE PRP -Implement a feature using using the PRP file. +Implement a feature using the PRP file. ## PRP File: $ARGUMENTS diff --git a/claude-code-full-guide/.claude/commands/generate-prp.md b/.amazonq/commands/generate-prp.md similarity index 68% rename from claude-code-full-guide/.claude/commands/generate-prp.md rename to .amazonq/commands/generate-prp.md index e1b4ac8be1..116fe990cb 100644 --- a/claude-code-full-guide/.claude/commands/generate-prp.md +++ b/.amazonq/commands/generate-prp.md @@ -2,9 +2,9 @@ ## Feature file: $ARGUMENTS -Generate a complete PRP for general feature implementation with thorough research. Ensure context is passed to the AI agent to enable self-validation and iterative refinement. Read the feature file first to understand what needs to be created, how the examples provided help, and any other considerations. +Generate a complete PRP for general feature implementation with thorough research. Ensure context is passed to Amazon Q to enable self-validation and iterative refinement. Read the feature file first to understand what needs to be created, how the examples provided help, and any other considerations. -The AI agent only gets the context you are appending to the PRP and training data. Assuma the AI agent has access to the codebase and the same knowledge cutoff as you, so its important that your research findings are included or referenced in the PRP. The Agent has Websearch capabilities, so pass urls to documentation and examples. +Amazon Q only gets the context you are appending to the PRP and training data. Assume Amazon Q has access to the codebase and the same knowledge cutoff as you, so its important that your research findings are included or referenced in the PRP. Amazon Q has web search capabilities, so pass URLs to documentation and examples. ## Research Process @@ -28,7 +28,7 @@ The AI agent only gets the context you are appending to the PRP and training dat Using PRPs/templates/prp_base.md as template: -### Critical Context to Include and pass to the AI agent as part of the PRP +### Critical Context to Include and pass to Amazon Q as part of the PRP - **Documentation**: URLs with specific sections - **Code Examples**: Real snippets from codebase - **Gotchas**: Library quirks, version issues @@ -38,7 +38,7 @@ Using PRPs/templates/prp_base.md as template: - Start with pseudocode showing approach - Reference real files for patterns - Include error handling strategy -- list tasks to be completed to fullfill the PRP in the order they should be completed +- list tasks to be completed to fulfill the PRP in the order they should be completed ### Validation Gates (Must be Executable) eg for python ```bash @@ -59,11 +59,11 @@ Save as: `PRPs/{feature-name}.md` ## Quality Checklist - [ ] All necessary context included -- [ ] Validation gates are executable by AI +- [ ] Validation gates are executable by Amazon Q - [ ] References existing patterns - [ ] Clear implementation path - [ ] Error handling documented -Score the PRP on a scale of 1-10 (confidence level to succeed in one-pass implementation using claude codes) +Score the PRP on a scale of 1-10 (confidence level to succeed in one-pass implementation using Amazon Q) Remember: The goal is one-pass implementation success through comprehensive context. \ No newline at end of file diff --git a/.claude/settings.local.json b/.amazonq/settings.local.json similarity index 90% rename from .claude/settings.local.json rename to .amazonq/settings.local.json index f3a9ca0c6c..d58c92df55 100644 --- a/.claude/settings.local.json +++ b/.amazonq/settings.local.json @@ -16,7 +16,7 @@ "Bash(python:*)", "Bash(python -m pytest:*)", "Bash(python3 -m pytest:*)", - "WebFetch(domain:docs.anthropic.com)", + "WebFetch(domain:docs.aws.amazon.com)", "WebFetch(domain:github.com)" ], "deny": [] diff --git a/AMAZONQ.md b/AMAZONQ.md new file mode 100644 index 0000000000..e6ab4335fa --- /dev/null +++ b/AMAZONQ.md @@ -0,0 +1,60 @@ +# Amazon Q Developer - Project Guidelines + +### ๐Ÿ”„ Project Awareness & Context +- **Always read `PLANNING.md`** at the start of a new conversation to understand the project's architecture, goals, style, and constraints. +- **Check `TASK.md`** before starting a new task. If the task isn't listed, add it with a brief description and today's date. +- **Use consistent naming conventions, file structure, and architecture patterns** as described in `PLANNING.md`. +- **Use venv_linux** (the virtual environment) whenever executing Python commands, including for unit tests. + +### ๐Ÿงฑ Code Structure & Modularity +- **Never create a file longer than 500 lines of code.** If a file approaches this limit, refactor by splitting it into modules or helper files. +- **Organize code into clearly separated modules**, grouped by feature or responsibility. + For agents this looks like: + - `agent.py` - Main agent definition and execution logic + - `tools.py` - Tool functions used by the agent + - `prompts.py` - System prompts +- **Use clear, consistent imports** (prefer relative imports within packages). +- **Use python_dotenv and load_env()** for environment variables. + +### ๐Ÿงช Testing & Reliability +- **Always create Pytest unit tests for new features** (functions, classes, routes, etc). +- **After updating any logic**, check whether existing unit tests need to be updated. If so, do it. +- **Tests should live in a `/tests` folder** mirroring the main app structure. + - Include at least: + - 1 test for expected use + - 1 edge case + - 1 failure case + +### โœ… Task Completion +- **Mark completed tasks in `TASK.md`** immediately after finishing them. +- Add new sub-tasks or TODOs discovered during development to `TASK.md` under a "Discovered During Work" section. + +### ๐Ÿ“Ž Style & Conventions +- **Use Python** as the primary language. +- **Follow PEP8**, use type hints, and format with `black`. +- **Use `pydantic` for data validation**. +- Use `FastAPI` for APIs and `SQLAlchemy` or `SQLModel` for ORM if applicable. +- Write **docstrings for every function** using the Google style: + ```python + def example(): + """ + Brief summary. + + Args: + param1 (type): Description. + + Returns: + type: Description. + """ + ``` + +### ๐Ÿ“š Documentation & Explainability +- **Update `README.md`** when new features are added, dependencies change, or setup steps are modified. +- **Comment non-obvious code** and ensure everything is understandable to a mid-level developer. +- When writing complex logic, **add an inline `# Reason:` comment** explaining the why, not just the what. + +### ๐Ÿง  AI Assistant Behavior Rules +- **Never assume missing context. Ask questions if uncertain.** +- **Never hallucinate libraries or functions** โ€“ only use known, verified Python packages. +- **Always confirm file paths and module names** exist before referencing them in code or tests. +- **Never delete or overwrite existing code** unless explicitly instructed to or if part of a task from `TASK.md`. \ No newline at end of file diff --git a/CONVERSION_SUMMARY.md b/CONVERSION_SUMMARY.md new file mode 100644 index 0000000000..7fc1b3aab9 --- /dev/null +++ b/CONVERSION_SUMMARY.md @@ -0,0 +1,128 @@ +# Context Engineering Template - Amazon Q Conversion Summary + +## Overview +This workspace has been successfully converted from Claude Code to Amazon Q Developer. All references, paths, and configurations have been updated to work with Amazon Q. + +## Changes Made + +### Directory Structure Changes +- `.claude/` โ†’ `.amazonq/` (all instances) +- `claude-code-full-guide/` โ†’ `amazonq-full-guide/` +- `CLAUDE.md` โ†’ `AMAZONQ.md` (all instances) + +### File Updates + +#### Root Level +- โœ… Created `.amazonq/` directory with commands and settings +- โœ… Updated `README.md` - replaced all Claude references with Amazon Q +- โœ… Created `AMAZONQ.md` - project guidelines for Amazon Q +- โœ… Renamed installation guide: `install_claude_code_windows.md` โ†’ `install_amazonq_windows.md` + +#### Amazon Q Commands (`.amazonq/commands/`) +- โœ… `generate-prp.md` - Updated to reference Amazon Q instead of Claude +- โœ… `execute-prp.md` - Updated execution instructions for Amazon Q +- โœ… `primer.md` - Updated context priming for Amazon Q + +#### Settings Files +- โœ… Updated `settings.local.json` files to use AWS documentation domains +- โœ… Replaced `docs.anthropic.com` with `docs.aws.amazon.com` + +#### Use Cases Converted +- โœ… `agent-factory-with-subagents/` - Directory structure and files updated +- โœ… `mcp-server/` - Directory structure and files updated +- โœ… `pydantic-ai/` - Directory structure and files updated +- โœ… `template-generator/` - Directory structure and files updated + +#### Full Guide Directory +- โœ… `amazonq-full-guide/` - Complete conversion with all commands and agents +- โœ… Updated all command files to reference Amazon Q +- โœ… Updated settings to use AWS documentation + +## Key Configuration Changes + +### Amazon Q Settings +```json +{ + "permissions": { + "allow": [ + "Bash(grep:*)", + "Bash(ls:*)", + "Bash(source:*)", + "Bash(find:*)", + "Bash(mv:*)", + "Bash(mkdir:*)", + "Bash(tree:*)", + "Bash(ruff:*)", + "Bash(touch:*)", + "Bash(cat:*)", + "Bash(ruff check:*)", + "Bash(pytest:*)", + "Bash(python:*)", + "Bash(python -m pytest:*)", + "Bash(python3 -m pytest:*)", + "WebFetch(domain:docs.aws.amazon.com)", + "WebFetch(domain:github.com)" + ], + "deny": [] + } +} +``` + +### Updated Commands +- `/generate-prp` - Now optimized for Amazon Q's capabilities +- `/execute-prp` - Updated execution flow for Amazon Q +- `/primer` - Context priming specifically for Amazon Q + +## Usage Instructions + +### Quick Start with Amazon Q +```bash +# 1. Clone this template +git clone https://github.com/coleam00/Context-Engineering-Intro.git +cd Context-Engineering-Intro + +# 2. Set up your project rules +# Edit AMAZONQ.md to add your project-specific guidelines + +# 3. Add examples +# Place relevant code examples in the examples/ folder + +# 4. Create your initial feature request +# Edit INITIAL.md with your feature requirements + +# 5. Generate a comprehensive PRP +# In Amazon Q, run: +/generate-prp INITIAL.md + +# 6. Execute the PRP to implement your feature +# In Amazon Q, run: +/execute-prp PRPs/your-feature-name.md +``` + +### Amazon Q Integration +- All commands now reference Amazon Q's capabilities +- Documentation links point to AWS resources +- Settings configured for Amazon Q Developer CLI +- Project guidelines tailored for Amazon Q workflow + +## Benefits of Amazon Q Integration +- **AWS Native**: Seamless integration with AWS services and documentation +- **Enterprise Ready**: Built for enterprise development workflows +- **Security Focused**: AWS security best practices built-in +- **Scalable**: Designed for large-scale development projects + +## Next Steps +1. Install Amazon Q Developer CLI +2. Configure your AWS credentials +3. Start using the `/generate-prp` and `/execute-prp` commands +4. Customize `AMAZONQ.md` for your specific project needs + +## Compatibility +- All existing PRPs and templates remain compatible +- Examples and patterns work unchanged +- Validation gates and testing patterns preserved +- Context engineering principles maintained + +--- + +**The Context Engineering methodology remains the same - only the AI assistant has changed from Claude to Amazon Q Developer.** \ No newline at end of file diff --git a/README.md b/README.md index d1843daca8..47753683d2 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ git clone https://github.com/coleam00/Context-Engineering-Intro.git cd Context-Engineering-Intro # 2. Set up your project rules (optional - template provided) -# Edit CLAUDE.md to add your project-specific guidelines +# Edit AMAZONQ.md to add your project-specific guidelines # 3. Add examples (highly recommended) # Place relevant code examples in the examples/ folder @@ -21,11 +21,11 @@ cd Context-Engineering-Intro # Edit INITIAL.md with your feature requirements # 5. Generate a comprehensive PRP (Product Requirements Prompt) -# In Claude Code, run: +# In Amazon Q, run: /generate-prp INITIAL.md # 6. Execute the PRP to implement your feature -# In Claude Code, run: +# In Amazon Q, run: /execute-prp PRPs/your-feature-name.md ``` @@ -66,17 +66,17 @@ Context Engineering represents a paradigm shift from traditional prompt engineer ``` context-engineering-intro/ -โ”œโ”€โ”€ .claude/ +โ”œโ”€โ”€ .amazonq/ โ”‚ โ”œโ”€โ”€ commands/ โ”‚ โ”‚ โ”œโ”€โ”€ generate-prp.md # Generates comprehensive PRPs โ”‚ โ”‚ โ””โ”€โ”€ execute-prp.md # Executes PRPs to implement features -โ”‚ โ””โ”€โ”€ settings.local.json # Claude Code permissions +โ”‚ โ””โ”€โ”€ settings.local.json # Amazon Q permissions โ”œโ”€โ”€ PRPs/ โ”‚ โ”œโ”€โ”€ templates/ โ”‚ โ”‚ โ””โ”€โ”€ prp_base.md # Base template for PRPs โ”‚ โ””โ”€โ”€ EXAMPLE_multi_agent_prp.md # Example of a complete PRP โ”œโ”€โ”€ examples/ # Your code examples (critical!) -โ”œโ”€โ”€ CLAUDE.md # Global rules for AI assistant +โ”œโ”€โ”€ AMAZONQ.md # Global rules for AI assistant โ”œโ”€โ”€ INITIAL.md # Template for feature requests โ”œโ”€โ”€ INITIAL_EXAMPLE.md # Example feature request โ””โ”€โ”€ README.md # This file @@ -86,9 +86,9 @@ This template doesn't focus on RAG and tools with context engineering because I ## Step-by-Step Guide -### 1. Set Up Global Rules (CLAUDE.md) +### 1. Set Up Global Rules (AMAZONQ.md) -The `CLAUDE.md` file contains project-wide rules that the AI assistant will follow in every conversation. The template includes: +The `AMAZONQ.md` file contains project-wide rules that Amazon Q will follow in every conversation. The template includes: - **Project awareness**: Reading planning docs, checking tasks - **Code structure**: File size limits, module organization @@ -129,14 +129,14 @@ PRPs (Product Requirements Prompts) are comprehensive implementation blueprints They are similar to PRDs (Product Requirements Documents) but are crafted more specifically to instruct an AI coding assistant. -Run in Claude Code: +Run in Amazon Q: ```bash /generate-prp INITIAL.md ``` -**Note:** The slash commands are custom commands defined in `.claude/commands/`. You can view their implementation: -- `.claude/commands/generate-prp.md` - See how it researches and creates PRPs -- `.claude/commands/execute-prp.md` - See how it implements features from PRPs +**Note:** The slash commands are custom commands defined in `.amazonq/commands/`. You can view their implementation: +- `.amazonq/commands/generate-prp.md` - See how it researches and creates PRPs +- `.amazonq/commands/execute-prp.md` - See how it implements features from PRPs The `$ARGUMENTS` variable in these commands receives whatever you pass after the command name (e.g., `INITIAL.md` or `PRPs/your-feature.md`). @@ -154,7 +154,7 @@ Once generated, execute the PRP to implement your feature: /execute-prp PRPs/your-feature-name.md ``` -The AI coding assistant will: +Amazon Q will: 1. Read all context from the PRP 2. Create a detailed implementation plan 3. Execute each step with validation @@ -224,7 +224,7 @@ See `PRPs/EXAMPLE_multi_agent_prp.md` for a complete example of what gets genera ## Using Examples Effectively -The `examples/` folder is **critical** for success. AI coding assistants perform much better when they can see patterns to follow. +The `examples/` folder is **critical** for success. Amazon Q performs much better when it can see patterns to follow. ### What to Include in Examples @@ -277,7 +277,7 @@ examples/ ### 3. Use Validation Gates - PRPs include test commands that must pass -- AI will iterate until all validations succeed +- Amazon Q will iterate until all validations succeed - This ensures working code on first try ### 4. Leverage Documentation @@ -285,12 +285,12 @@ examples/ - Add MCP server resources - Reference specific documentation sections -### 5. Customize CLAUDE.md +### 5. Customize AMAZONQ.md - Add your conventions - Include project-specific rules - Define coding standards ## Resources -- [Claude Code Documentation](https://docs.anthropic.com/en/docs/claude-code) +- [Amazon Q Developer Documentation](https://docs.aws.amazon.com/amazonq/) - [Context Engineering Best Practices](https://www.philschmid.de/context-engineering) \ No newline at end of file diff --git a/claude-code-full-guide/.claude/agents/documentation-manager.md b/amazonq-full-guide/.amazonq/agents/documentation-manager.md similarity index 100% rename from claude-code-full-guide/.claude/agents/documentation-manager.md rename to amazonq-full-guide/.amazonq/agents/documentation-manager.md diff --git a/claude-code-full-guide/.claude/agents/validation-gates.md b/amazonq-full-guide/.amazonq/agents/validation-gates.md similarity index 100% rename from claude-code-full-guide/.claude/agents/validation-gates.md rename to amazonq-full-guide/.amazonq/agents/validation-gates.md diff --git a/claude-code-full-guide/.claude/commands/execute-parallel.md b/amazonq-full-guide/.amazonq/commands/execute-parallel.md similarity index 100% rename from claude-code-full-guide/.claude/commands/execute-parallel.md rename to amazonq-full-guide/.amazonq/commands/execute-parallel.md diff --git a/.claude/commands/execute-prp.md b/amazonq-full-guide/.amazonq/commands/execute-prp.md similarity index 100% rename from .claude/commands/execute-prp.md rename to amazonq-full-guide/.amazonq/commands/execute-prp.md diff --git a/claude-code-full-guide/.claude/commands/fix-github-issue.md b/amazonq-full-guide/.amazonq/commands/fix-github-issue.md similarity index 100% rename from claude-code-full-guide/.claude/commands/fix-github-issue.md rename to amazonq-full-guide/.amazonq/commands/fix-github-issue.md diff --git a/.claude/commands/generate-prp.md b/amazonq-full-guide/.amazonq/commands/generate-prp.md similarity index 71% rename from .claude/commands/generate-prp.md rename to amazonq-full-guide/.amazonq/commands/generate-prp.md index e1b4ac8be1..bc57a22ce9 100644 --- a/.claude/commands/generate-prp.md +++ b/amazonq-full-guide/.amazonq/commands/generate-prp.md @@ -2,9 +2,9 @@ ## Feature file: $ARGUMENTS -Generate a complete PRP for general feature implementation with thorough research. Ensure context is passed to the AI agent to enable self-validation and iterative refinement. Read the feature file first to understand what needs to be created, how the examples provided help, and any other considerations. +Generate a complete PRP for general feature implementation with thorough research. Ensure context is passed to Amazon Q to enable self-validation and iterative refinement. Read the feature file first to understand what needs to be created, how the examples provided help, and any other considerations. -The AI agent only gets the context you are appending to the PRP and training data. Assuma the AI agent has access to the codebase and the same knowledge cutoff as you, so its important that your research findings are included or referenced in the PRP. The Agent has Websearch capabilities, so pass urls to documentation and examples. +Amazon Q only gets the context you are appending to the PRP and training data. Assume Amazon Q has access to the codebase and the same knowledge cutoff as you, so its important that your research findings are included or referenced in the PRP. Amazon Q has web search capabilities, so pass URLs to documentation and examples. ## Research Process @@ -28,7 +28,7 @@ The AI agent only gets the context you are appending to the PRP and training dat Using PRPs/templates/prp_base.md as template: -### Critical Context to Include and pass to the AI agent as part of the PRP +### Critical Context to Include and pass to Amazon Q as part of the PRP - **Documentation**: URLs with specific sections - **Code Examples**: Real snippets from codebase - **Gotchas**: Library quirks, version issues @@ -59,11 +59,11 @@ Save as: `PRPs/{feature-name}.md` ## Quality Checklist - [ ] All necessary context included -- [ ] Validation gates are executable by AI +- [ ] Validation gates are executable by Amazon Q - [ ] References existing patterns - [ ] Clear implementation path - [ ] Error handling documented -Score the PRP on a scale of 1-10 (confidence level to succeed in one-pass implementation using claude codes) +Score the PRP on a scale of 1-10 (confidence level to succeed in one-pass implementation using Amazon Q) Remember: The goal is one-pass implementation success through comprehensive context. \ No newline at end of file diff --git a/claude-code-full-guide/.claude/commands/prep-parallel.md b/amazonq-full-guide/.amazonq/commands/prep-parallel.md similarity index 100% rename from claude-code-full-guide/.claude/commands/prep-parallel.md rename to amazonq-full-guide/.amazonq/commands/prep-parallel.md diff --git a/claude-code-full-guide/.claude/commands/primer.md b/amazonq-full-guide/.amazonq/commands/primer.md similarity index 73% rename from claude-code-full-guide/.claude/commands/primer.md rename to amazonq-full-guide/.amazonq/commands/primer.md index 9ad03668fe..44732568d1 100644 --- a/claude-code-full-guide/.claude/commands/primer.md +++ b/amazonq-full-guide/.amazonq/commands/primer.md @@ -1,8 +1,8 @@ -# Prime Context for Claude Code +# Prime Context for Amazon Q Use the command `tree` to get an understanding of the project structure. -Start with reading the CLAUDE.md file if it exists to get an understanding of the project. +Start with reading the AMAZONQ.md file if it exists to get an understanding of the project. Read the README.md file to get an understanding of the project. diff --git a/claude-code-full-guide/.claude/hooks/README.md b/amazonq-full-guide/.amazonq/hooks/README.md similarity index 100% rename from claude-code-full-guide/.claude/hooks/README.md rename to amazonq-full-guide/.amazonq/hooks/README.md diff --git a/claude-code-full-guide/.claude/hooks/example-hook-config.json b/amazonq-full-guide/.amazonq/hooks/example-hook-config.json similarity index 100% rename from claude-code-full-guide/.claude/hooks/example-hook-config.json rename to amazonq-full-guide/.amazonq/hooks/example-hook-config.json diff --git a/claude-code-full-guide/.claude/hooks/log-tool-usage.sh b/amazonq-full-guide/.amazonq/hooks/log-tool-usage.sh similarity index 100% rename from claude-code-full-guide/.claude/hooks/log-tool-usage.sh rename to amazonq-full-guide/.amazonq/hooks/log-tool-usage.sh diff --git a/claude-code-full-guide/.claude/settings.local.json b/amazonq-full-guide/.amazonq/settings.local.json similarity index 91% rename from claude-code-full-guide/.claude/settings.local.json rename to amazonq-full-guide/.amazonq/settings.local.json index 2b7cdfd7b9..d92ac7a847 100644 --- a/claude-code-full-guide/.claude/settings.local.json +++ b/amazonq-full-guide/.amazonq/settings.local.json @@ -19,7 +19,7 @@ "Bash(python3 -m pytest:*)", "WebFetch(domain:*)", "Bash(gh issue view:*)", - "WebFetch(domain:docs.anthropic.com)" + "WebFetch(domain:docs.aws.amazon.com)" ], "deny": [] } diff --git a/claude-code-full-guide/.devcontainer/Dockerfile b/amazonq-full-guide/.devcontainer/Dockerfile similarity index 100% rename from claude-code-full-guide/.devcontainer/Dockerfile rename to amazonq-full-guide/.devcontainer/Dockerfile diff --git a/claude-code-full-guide/.devcontainer/devcontainer.json b/amazonq-full-guide/.devcontainer/devcontainer.json similarity index 100% rename from claude-code-full-guide/.devcontainer/devcontainer.json rename to amazonq-full-guide/.devcontainer/devcontainer.json diff --git a/claude-code-full-guide/.devcontainer/init-firewall.sh b/amazonq-full-guide/.devcontainer/init-firewall.sh similarity index 100% rename from claude-code-full-guide/.devcontainer/init-firewall.sh rename to amazonq-full-guide/.devcontainer/init-firewall.sh diff --git a/claude-code-full-guide/CLAUDE.md b/amazonq-full-guide/AMAZONQ.md similarity index 98% rename from claude-code-full-guide/CLAUDE.md rename to amazonq-full-guide/AMAZONQ.md index 2a2bffec81..09619fc4b6 100644 --- a/claude-code-full-guide/CLAUDE.md +++ b/amazonq-full-guide/AMAZONQ.md @@ -1,6 +1,6 @@ -# CLAUDE.md +# AMAZONQ.md -This file provides comprehensive guidance to Claude Code when working with Python code in this repository. +This file provides comprehensive guidance to Amazon Q Developer when working with Python code in this repository. ## Core Development Philosophy @@ -418,7 +418,7 @@ class Product(ProductBase): ### Commit Message Format -Never include claude code, or written by claude code in commit messages +Never include Amazon Q, or written by Amazon Q in commit messages ``` (): @@ -703,7 +703,7 @@ logger.info( - **NEVER ASSUME OR GUESS** - When in doubt, ask for clarification - **Always verify file paths and module names** before use -- **Keep CLAUDE.md updated** when adding new patterns or dependencies +- **Keep AMAZONQ.md updated** when adding new patterns or dependencies - **Test your code** - No feature is complete without tests - **Document your decisions** - Future developers (including yourself) will thank you diff --git a/claude-code-full-guide/INITIAL.md b/amazonq-full-guide/INITIAL.md similarity index 100% rename from claude-code-full-guide/INITIAL.md rename to amazonq-full-guide/INITIAL.md diff --git a/claude-code-full-guide/PRPs/EXAMPLE_multi_agent_prp.md b/amazonq-full-guide/PRPs/EXAMPLE_multi_agent_prp.md similarity index 100% rename from claude-code-full-guide/PRPs/EXAMPLE_multi_agent_prp.md rename to amazonq-full-guide/PRPs/EXAMPLE_multi_agent_prp.md diff --git a/claude-code-full-guide/PRPs/templates/prp_base.md b/amazonq-full-guide/PRPs/templates/prp_base.md similarity index 100% rename from claude-code-full-guide/PRPs/templates/prp_base.md rename to amazonq-full-guide/PRPs/templates/prp_base.md diff --git a/claude-code-full-guide/README.md b/amazonq-full-guide/README.md similarity index 100% rename from claude-code-full-guide/README.md rename to amazonq-full-guide/README.md diff --git a/claude-code-full-guide/install_claude_code_windows.md b/amazonq-full-guide/install_amazonq_windows.md similarity index 72% rename from claude-code-full-guide/install_claude_code_windows.md rename to amazonq-full-guide/install_amazonq_windows.md index 752a1f0722..6eb7e4298a 100644 --- a/claude-code-full-guide/install_claude_code_windows.md +++ b/amazonq-full-guide/install_amazonq_windows.md @@ -1,6 +1,6 @@ -## Installing Claude Code on Windows (with WSL) +## Installing Amazon Q Developer on Windows (with WSL) -Claude Code only supports Linux and MacOS by default. To use Claude Code with Windows, you can use WSL. +Amazon Q Developer CLI works best on Linux and MacOS. To use Amazon Q Developer with Windows, you can use WSL. 1. Go to the Microsoft Store @@ -26,8 +26,8 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc # Apply the new PATH setting source ~/.bashrc -# Now reinstall Claude Code in the new location -npm install -g @anthropic-ai/claude-code +# Now install Amazon Q Developer CLI in the new location +npm install -g @aws/amazon-q-developer-cli ``` -5. Now within your IDEs you can open a terminal with Ctrl + J (also use this hotkey to toggle it off) and you can click on the down arrow next to the plus to open an Ubuntu (WSL) terminal where you can run the "claude" command to start Claude Code. \ No newline at end of file +5. Now within your IDEs you can open a terminal with Ctrl + J (also use this hotkey to toggle it off) and you can click on the down arrow next to the plus to open an Ubuntu (WSL) terminal where you can run the "q" command to start Amazon Q Developer. \ No newline at end of file diff --git a/use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-dependency-manager.md b/use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-dependency-manager.md similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-dependency-manager.md rename to use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-dependency-manager.md diff --git a/use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-planner.md b/use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-planner.md similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-planner.md rename to use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-planner.md diff --git a/use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-prompt-engineer.md b/use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-prompt-engineer.md similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-prompt-engineer.md rename to use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-prompt-engineer.md diff --git a/use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-tool-integrator.md b/use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-tool-integrator.md similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-tool-integrator.md rename to use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-tool-integrator.md diff --git a/use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-validator.md b/use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-validator.md similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/agents/pydantic-ai-validator.md rename to use-cases/agent-factory-with-subagents/.amazonq/agents/pydantic-ai-validator.md diff --git a/use-cases/agent-factory-with-subagents/.claude/settings.local.json b/use-cases/agent-factory-with-subagents/.amazonq/settings.local.json similarity index 100% rename from use-cases/agent-factory-with-subagents/.claude/settings.local.json rename to use-cases/agent-factory-with-subagents/.amazonq/settings.local.json diff --git a/use-cases/agent-factory-with-subagents/CLAUDE.md b/use-cases/agent-factory-with-subagents/AMAZONQ.md similarity index 100% rename from use-cases/agent-factory-with-subagents/CLAUDE.md rename to use-cases/agent-factory-with-subagents/AMAZONQ.md diff --git a/use-cases/mcp-server/.claude/commands/prp-mcp-create.md b/use-cases/mcp-server/.amazonq/commands/prp-mcp-create.md similarity index 100% rename from use-cases/mcp-server/.claude/commands/prp-mcp-create.md rename to use-cases/mcp-server/.amazonq/commands/prp-mcp-create.md diff --git a/use-cases/mcp-server/.claude/commands/prp-mcp-execute.md b/use-cases/mcp-server/.amazonq/commands/prp-mcp-execute.md similarity index 100% rename from use-cases/mcp-server/.claude/commands/prp-mcp-execute.md rename to use-cases/mcp-server/.amazonq/commands/prp-mcp-execute.md diff --git a/use-cases/mcp-server/.claude/settings.local.json b/use-cases/mcp-server/.amazonq/settings.local.json similarity index 100% rename from use-cases/mcp-server/.claude/settings.local.json rename to use-cases/mcp-server/.amazonq/settings.local.json diff --git a/use-cases/mcp-server/CLAUDE.md b/use-cases/mcp-server/AMAZONQ.md similarity index 100% rename from use-cases/mcp-server/CLAUDE.md rename to use-cases/mcp-server/AMAZONQ.md diff --git a/use-cases/pydantic-ai/.claude/commands/execute-pydantic-ai-prp.md b/use-cases/pydantic-ai/.amazonq/commands/execute-pydantic-ai-prp.md similarity index 100% rename from use-cases/pydantic-ai/.claude/commands/execute-pydantic-ai-prp.md rename to use-cases/pydantic-ai/.amazonq/commands/execute-pydantic-ai-prp.md diff --git a/use-cases/pydantic-ai/.claude/commands/generate-pydantic-ai-prp.md b/use-cases/pydantic-ai/.amazonq/commands/generate-pydantic-ai-prp.md similarity index 100% rename from use-cases/pydantic-ai/.claude/commands/generate-pydantic-ai-prp.md rename to use-cases/pydantic-ai/.amazonq/commands/generate-pydantic-ai-prp.md diff --git a/use-cases/pydantic-ai/CLAUDE.md b/use-cases/pydantic-ai/AMAZONQ.md similarity index 100% rename from use-cases/pydantic-ai/CLAUDE.md rename to use-cases/pydantic-ai/AMAZONQ.md diff --git a/use-cases/template-generator/.claude/commands/execute-template-prp.md b/use-cases/template-generator/.amazonq/commands/execute-template-prp.md similarity index 100% rename from use-cases/template-generator/.claude/commands/execute-template-prp.md rename to use-cases/template-generator/.amazonq/commands/execute-template-prp.md diff --git a/use-cases/template-generator/.claude/commands/generate-template-prp.md b/use-cases/template-generator/.amazonq/commands/generate-template-prp.md similarity index 100% rename from use-cases/template-generator/.claude/commands/generate-template-prp.md rename to use-cases/template-generator/.amazonq/commands/generate-template-prp.md diff --git a/use-cases/template-generator/.claude/settings.local.json b/use-cases/template-generator/.amazonq/settings.local.json similarity index 100% rename from use-cases/template-generator/.claude/settings.local.json rename to use-cases/template-generator/.amazonq/settings.local.json diff --git a/use-cases/template-generator/CLAUDE.md b/use-cases/template-generator/AMAZONQ.md similarity index 100% rename from use-cases/template-generator/CLAUDE.md rename to use-cases/template-generator/AMAZONQ.md