ArchiQ - Amazon Q-powered Architecture Reviewer

A simplified AWS architecture analysis tool with two main analysis paths and language support.

Sample SHIP Report(KR version)

Samples Report HTML

🚀 Quick Start

# AWS resource-based analysis (no external files needed)
./run_aws_analysis.sh

# Service Screener analysis (requires Service Screener output files)
./run_service_screener_analysis.sh

📁 Project Structure

sample-q-architecture-reviewer/
├── run_aws_analysis.sh               # AWS resource-based analysis
├── run_service_screener_analysis.sh  # Service Screener output analysis
├── prompts/                          # Analysis prompts
│   ├── en/                          # English prompts
│   │   ├── aws_security.md
│   │   ├── aws_well-architected.md
│   │   ├── aws_architecture.md
│   │   ├── aws_modernization.md
│   │   ├── service_screener_review.md
│   │   └── service_screener_ship.md
│   └── kr/                          # Korean prompts
│       ├── aws_security.md
│       ├── aws_well-architected.md
│       ├── aws_architecture.md
│       ├── aws_modernization.md
│       ├── service_screener_review.md
│       └── service_screener_ship.md
└── output/                          # Generated reports
    ├── security/
    ├── well-architected/
    ├── architecture/
    ├── modernization/
    └── service-screener/

🛠️ Usage

AWS Resource Analysis

Analyzes your current AWS resources using AWS credentials:

# Interactive menu
./run_aws_analysis.sh

# Direct analysis
./run_aws_analysis.sh security -r us-east-1 -l kr
./run_aws_analysis.sh well-architected -l en
./run_aws_analysis.sh architecture -r eu-west-1
./run_aws_analysis.sh modernization -l kr

Analysis Types:

• security - Security assessment
• well-architected - Well-Architected Framework review
• architecture - Architecture diagram generation
• modernization - Modernization path analysis

Service Screener Analysis

Analyzes Service Screener output files:

# Interactive menu
./run_service_screener_analysis.sh

# Direct analysis
./run_service_screener_analysis.sh review -d /path/to/screener-results -l en
./run_service_screener_analysis.sh ship -d /path/to/results -l kr

Analysis Types:

• review - General Well-Architected review
• ship - SHIP (Security Health Improvement Program) review

🌐 Language Support

• English: -l en (default)
• Korean: -l kr

📊 Output

All reports are generated as HTML files in the output/ directory with timestamps:

• aws_security_assessment_us-east-1_20241021_220223.html
• aws_well_architected_us-east-1_20241021_220223.html
• aws_architecture_diagram_us-east-1_20241021_220223.html
• aws_modernization_path_us-east-1_20241021_220223.html
• service_screener_review_20241021_220223.html
• service_screener_ship_20241021_220223.html

⚙️ Prerequisites

• AWS CLI configured with appropriate credentials
• Amazon Q CLI installed
• Bash shell environment

🔧 Options

AWS Analysis Options

• -r, --region REGION - AWS region (default: ap-northeast-2)
• -l, --lang LANG - Language: en/kr (default: en)
• -h, --help - Show help

Service Screener Analysis Options

• -d, --dir PATH - Service Screener results directory (required)
• -l, --lang LANG - Language: en/kr (default: en)
• -h, --help - Show help