Skip to content

DavidROliverBA/SAAT-ClaudeCode

Repository files navigation

SAAT Claude Code Sub-Agents

Solution Architects Analysis Toolkit for Claude Code

A comprehensive suite of 11 specialized AI sub-agents that provide professional-grade software architecture analysis, design, validation, security assessment, documentation, and infrastructure generation.

License: MIT Claude Code


🎯 What is SAAT?

SAAT (Solution Architects Analysis Toolkit) provides AI-powered architecture analysis through specialized sub-agents that can:

  • πŸ” Discover existing codebases and identify architecture patterns
  • πŸ“‹ Extract requirements from business documents
  • πŸ—οΈ Generate standardized C4 architecture models
  • πŸ“Š Analyze quality against 14 architecture characteristics
  • βœ… Validate models for correctness and compliance
  • πŸ”’ Audit security and identify vulnerabilities
  • πŸ“š Document architecture with diagrams and ADRs
  • πŸ—οΈ Generate production-ready Terraform infrastructure
  • 🎯 Orchestrate complete workflows tailored to your needs

πŸš€ Installation

Prerequisites

Before installing SAAT, ensure you have:

  • βœ… Claude Code installed and configured (Download here)
  • βœ… Bash shell (Linux, macOS, or Windows with WSL2/Git Bash)
  • βœ… Git (optional, for cloning - or download ZIP from GitHub)

Quick Install (Recommended)

Step 1: Get the repository

# Option A: Clone with Git
git clone https://github.com/DavidROliverBA/SAAT-ClaudeCode.git
cd SAAT-ClaudeCode

# Option B: Download and extract ZIP, then:
cd SAAT-ClaudeCode

Step 2: Run the installation script

./scripts/install.sh

What happens during installation:

  • βœ… Creates ~/.claude/agents/ directory (if it doesn't exist)
  • βœ… Copies all 11 SAAT agents globally
  • βœ… Makes agents available across all your projects
  • βœ… Takes less than 1 minute!

Step 3: Verify installation

# Check that agents are installed
ls -1 ~/.claude/agents/saat-*.md

# You should see 11 agent files

Alternative Installation Methods

Manual Installation (click to expand)
# Clone or download repository
cd SAAT-ClaudeCode

# Create global agents directory
mkdir -p ~/.claude/agents

# Copy all agents
cp agents/*.md ~/.claude/agents/

# Verify
ls -la ~/.claude/agents/saat-*.md
Project-Specific Installation (click to expand)

Install to a specific project instead of globally:

# Navigate to your project
cd /path/to/your/project

# Create project agents directory
mkdir -p .claude/agents

# Copy agents from SAAT repository
cp /path/to/SAAT-ClaudeCode/agents/*.md .claude/agents/

# Agents now available only in this project

Note: Project-level agents take precedence over global agents.

Windows (PowerShell) Installation (click to expand)
# Clone repository
git clone https://github.com/DavidROliverBA/SAAT-ClaudeCode.git
cd SAAT-ClaudeCode

# Create agents directory
New-Item -Path "$env:USERPROFILE\.claude\agents" -ItemType Directory -Force

# Copy agents
Copy-Item -Path "agents\*.md" -Destination "$env:USERPROFILE\.claude\agents\"

# Verify
Get-ChildItem "$env:USERPROFILE\.claude\agents\saat-*.md"

First Use

Open Claude Code and invoke your first agent:

Method 1: Guided Experience (Recommended for beginners)

In Claude Code, use the Task tool:
  subagent_type: "saat-orchestrate"
  prompt: "I want to analyze my e-commerce platform for security and performance"

Method 2: Get Help

Task tool:
  subagent_type: "saat-help"
  prompt: "Show me all available SAAT commands"

Method 3: Quick Full Analysis

Task tool:
  subagent_type: "saat-full-pipeline"
  prompt: "Analyze /path/to/my/project"

The orchestrator will guide you through a personalized analysis workflow!

Troubleshooting Installation

Issue: Script says "permission denied"

chmod +x scripts/install.sh
./scripts/install.sh

Issue: Agents not showing in Claude Code

  • Restart Claude Code after installation
  • Verify files exist: ls ~/.claude/agents/saat-*.md
  • Check file permissions: chmod 644 ~/.claude/agents/saat-*.md

For more help: See INSTALLATION.md for comprehensive troubleshooting.


🌐 Web Dashboard

SAAT includes a modern web-based dashboard for managing projects, running agents, and visualizing results.

Features

  • πŸ“ Project Management: Add local folders or clone GitHub repositories
  • πŸ€– Agent Browser: Explore all 11 SAAT agents with detailed descriptions
  • ⚑ Real-time Execution: Run agents with live progress updates via WebSocket
  • πŸ“Š Results Visualization: View analysis results and statistics
  • πŸ” Search & Filter: Quickly find projects and agents

Quick Start

# Install dependencies
cd dashboard/backend && npm install
cd ../frontend && npm install

# Start backend (Terminal 1)
cd dashboard/backend
npm run dev

# Start frontend (Terminal 2)
cd dashboard/frontend
npm run dev

# Open http://localhost:3000

Full documentation: dashboard/README.md


πŸ“¦ What's Included

11 Specialized Sub-Agents

Agent Purpose Use Case
saat-orchestrate AI architecture consultant Start here! Guided experience
saat-discover Analyze existing codebases Brownfield analysis
saat-requirements Extract requirements Greenfield design
saat-generate Create C4 models Architecture modeling
saat-analyze-characteristics Evaluate quality Quality assessment
saat-validate Validate models Correctness checking
saat-security Security analysis Vulnerability assessment
saat-document Generate documentation Documentation suite
saat-terraform Generate infrastructure Infrastructure as Code
saat-full-pipeline Complete workflow One-command analysis
saat-help Help & guidance Reference documentation

πŸŽ“ Use Cases

1. Analyze Existing Application (Brownfield)

Task(subagent_type="saat-discover", prompt="Analyze /path/to/my-app")
β†’ Task(subagent_type="saat-generate", prompt="Generate C4 from discovery.json")
β†’ Task(subagent_type="saat-security", prompt="Analyze security")

Or use the full pipeline:

Task(subagent_type="saat-full-pipeline", prompt="Analyze /path/to/my-app")

2. Design New System (Greenfield)

Task(subagent_type="saat-requirements", prompt="Extract from requirements.md")
β†’ Task(subagent_type="saat-generate", prompt="Generate C4 from requirements.json")
β†’ Task(subagent_type="saat-document", prompt="Create documentation")

3. Security Audit

Task(subagent_type="saat-security", prompt="Analyze architecture.json with threat modeling")

4. Architecture Review

Task(subagent_type="saat-analyze-characteristics", prompt="Analyze architecture.json against characteristics.json")
β†’ Task(subagent_type="saat-validate", prompt="Validate architecture.json for PCI-DSS")

5. Infrastructure Generation

Task(subagent_type="saat-terraform", prompt="Generate AWS infrastructure from architecture.json")

πŸ“Š Architecture Characteristics

SAAT evaluates 14 standard architecture characteristics based on Mark Richards' methodology:

Operational (7)

  • Availability, Scalability, Performance, Security, Reliability, Fault Tolerance, Recoverability

Structural (5)

  • Maintainability, Testability, Deployability, Configurability, Extensibility

Cross-Cutting (2)

  • Interoperability, Usability

πŸ—οΈ Complete Feature Set

πŸ€– 11 Specialized Agents

  • saat-orchestrator - AI-powered guidance and workflow orchestration
  • saat-discover - Automated codebase analysis and pattern detection
  • saat-requirements - Intelligent requirements extraction
  • saat-generate - C4 architecture model generation with criticality assignment
  • saat-analyze-characteristics - Quality evaluation against 14 characteristics
  • saat-validate - Model validation and compliance checking
  • saat-security - Deep security audit with STRIDE threat modeling
  • saat-document - Comprehensive documentation generation
  • saat-terraform - Multi-cloud infrastructure as code
  • saat-full-pipeline - Complete workflow automation
  • saat-help - Interactive help and reference system

πŸ“š Comprehensive Examples

  • 5 Domain-Specific Characteristics: E-commerce, Healthcare, Fintech, SaaS, Microservices
  • Sample Outputs: Discovery, Architecture, Analysis, Validation, Security reports
  • Requirements Documents: Complete examples with functional/non-functional requirements
  • Learning Paths: Beginner β†’ Intermediate β†’ Advanced guides

πŸŽ“ Reference Architecture Walkthroughs

  • E-Commerce Platform (Brownfield, 6-hour walkthrough)
    • Monolith to microservices migration
    • PCI-DSS compliance focus
    • Active-active deployment strategies
  • API Gateway (Greenfield, 4-hour walkthrough)
    • High-performance design (<10ms p99 latency)
    • Multi-cloud deployment (AWS + GCP)
    • API security patterns
  • Healthcare Portal (HIPAA, 8-hour walkthrough)
    • HIPAA Security Rule compliance
    • Zero trust architecture
    • PHI protection strategies

🌐 Web Dashboard (Beta)

  • Project Management: Local folders and GitHub repositories
  • Agent Browser: Explore and execute all 11 agents
  • Real-time Updates: WebSocket-based progress tracking
  • Analysis Visualization: View results and statistics
  • RESTful API: Complete backend for automation

πŸ› οΈ Developer Tools

  • Badge Generator: Create shields.io badges from analysis results
  • GitHub Actions: CI/CD workflow template for automated analysis
  • Shell Completions: Bash and Zsh tab completion
  • Docker Image: Containerized SAAT with helper CLI
  • Interactive Generator: Guided questionnaire for characteristics files

πŸ—οΈ C4 Model Generation

  • Level 1 (Systems), Level 2 (Containers), Level 3 (Components)
  • Relationships with protocols and data flows
  • Criticality levels: CS1 (99.99%), CS2 (99.9%), SL1 (99.5%), SL2 (99%), STANDARD
  • Owner assignment and team mapping
  • Technology stack detection

βœ… Compliance Frameworks

  • PCI-DSS: Payment Card Industry Data Security Standard
  • HIPAA: Health Insurance Portability and Accountability Act
  • GDPR: General Data Protection Regulation
  • SOC2: Service Organization Control 2
  • Custom Frameworks: Define your own compliance rules

☁️ Multi-Cloud Infrastructure

  • AWS: EKS, RDS, ElastiCache, ALB, VPC, CloudWatch, S3
  • Azure: AKS, SQL Database, Redis Cache, Load Balancer, VNet
  • GCP: GKE, Cloud SQL, Memorystore, Load Balancer, VPC
  • Multi-region: Active-active, disaster recovery configurations

πŸ“ Documentation Formats

  • Markdown: README, ARCHITECTURE, API docs, runbooks
  • PlantUML: C4 diagrams with automatic generation
  • Mermaid: GitHub-friendly diagrams
  • ADRs: Architecture Decision Records with templates
  • Confluence/Wiki: Export-ready formats

πŸ”’ Security Analysis

  • Encryption gaps (at rest, in transit, key management)
  • Authentication/authorization issues (OAuth, JWT, RBAC, ABAC)
  • Data flow security analysis
  • Infrastructure vulnerabilities
  • STRIDE Threat Modeling: Spoofing, Tampering, Repudiation, Information Disclosure, DoS, Elevation of Privilege
  • Attack surface mapping
  • CVSS scoring for findings

πŸ“– Documentation

  • Installation Guide - Complete installation instructions
  • Agents Guide - Comprehensive reference for all agents
  • Examples - See examples/ directory for sample files

πŸ”§ Requirements

Required

  • Claude Code (latest version recommended)
  • Operating System: Linux, macOS, or Windows (WSL2/Git Bash)

Optional

  • Git (for cloning repository)
  • Terraform (for infrastructure deployment)
  • Cloud CLI (AWS CLI, Azure CLI, gcloud - for infrastructure deployment)

πŸ’‘ Example Workflows

Quick Assessment (5-10 minutes)

Task(
  subagent_type="saat-full-pipeline",
  prompt="Analyze /home/user/projects/my-app, output to ./analysis, use AWS"
)

Generates:

  • βœ… discovery.json
  • βœ… architecture.json
  • βœ… Quality analysis report
  • βœ… Validation report
  • βœ… Security audit
  • βœ… Complete documentation
  • βœ… Terraform infrastructure

Guided Experience (10-15 minutes)

Task(
  subagent_type="saat-orchestrate",
  prompt="I need to analyze my system for modernization"
)

The orchestrator will:

  1. Ask about your situation
  2. Understand your concerns
  3. Create a personalized plan
  4. Execute the workflow
  5. Deliver actionable recommendations

Custom Workflow

# Step 1: Discover
Task(subagent_type="saat-discover", prompt="Analyze /path/to/repo")

# Step 2: Generate C4
Task(subagent_type="saat-generate", prompt="Generate from discovery.json")

# Step 3: Analyze Quality
Task(subagent_type="saat-analyze-characteristics", prompt="Analyze against characteristics.json")

# Step 4: Security Audit
Task(subagent_type="saat-security", prompt="Deep security analysis with threat modeling")

# Step 5: Document
Task(subagent_type="saat-document", prompt="Generate complete documentation")

πŸ—‚οΈ Project Structure

SAAT-ClaudeCode/
β”œβ”€β”€ agents/                              # 11 specialized sub-agents
β”‚   β”œβ”€β”€ saat-orchestrator.md            # AI architecture consultant
β”‚   β”œβ”€β”€ saat-discover.md                # Codebase analysis
β”‚   β”œβ”€β”€ saat-requirements.md            # Requirements extraction
β”‚   β”œβ”€β”€ saat-generate.md                # C4 model generation
β”‚   β”œβ”€β”€ saat-analyze-characteristics.md # Quality analysis
β”‚   β”œβ”€β”€ saat-validate.md                # Model validation
β”‚   β”œβ”€β”€ saat-security.md                # Security audit
β”‚   β”œβ”€β”€ saat-document.md                # Documentation generation
β”‚   β”œβ”€β”€ saat-terraform.md               # Infrastructure generation
β”‚   β”œβ”€β”€ saat-full-pipeline.md           # Complete workflow
β”‚   └── saat-help.md                    # Help system
β”‚
β”œβ”€β”€ scripts/                             # Automation scripts
β”‚   β”œβ”€β”€ install.sh                      # Install agents globally
β”‚   β”œβ”€β”€ uninstall.sh                    # Remove agents
β”‚   β”œβ”€β”€ generate-badges.sh              # Create shields.io badges
β”‚   └── create-characteristics.sh       # Interactive generator
β”‚
β”œβ”€β”€ examples/                            # Comprehensive examples
β”‚   β”œβ”€β”€ characteristics/                # 5 domain-specific examples
β”‚   β”‚   β”œβ”€β”€ ecommerce-characteristics.json
β”‚   β”‚   β”œβ”€β”€ healthcare-characteristics.json
β”‚   β”‚   β”œβ”€β”€ fintech-characteristics.json
β”‚   β”‚   β”œβ”€β”€ saas-characteristics.json
β”‚   β”‚   └── microservices-characteristics.json
β”‚   β”œβ”€β”€ sample-outputs/                 # Analysis output samples
β”‚   β”‚   β”œβ”€β”€ discovery-sample.json
β”‚   β”‚   β”œβ”€β”€ architecture-sample.json
β”‚   β”‚   β”œβ”€β”€ archchar-analysis-sample.json
β”‚   β”‚   β”œβ”€β”€ archchar-analysis-sample.md
β”‚   β”‚   β”œβ”€β”€ validation-report-sample.json
β”‚   β”‚   └── security-report-sample.json
β”‚   β”œβ”€β”€ requirements/                   # Requirements documents
β”‚   β”‚   └── ecommerce-requirements.md
β”‚   └── README.md                       # Examples guide
β”‚
β”œβ”€β”€ reference-projects/                  # Complete walkthroughs
β”‚   β”œβ”€β”€ ecommerce-platform/             # Brownfield migration
β”‚   β”‚   β”œβ”€β”€ README.md                   # Project overview
β”‚   β”‚   └── WALKTHROUGH.md              # 6-hour guide
β”‚   β”œβ”€β”€ microservices-gateway/          # Greenfield design
β”‚   β”‚   β”œβ”€β”€ README.md                   # Project overview
β”‚   β”‚   └── WALKTHROUGH.md              # 4-hour guide
β”‚   β”œβ”€β”€ healthcare-portal/              # HIPAA compliance
β”‚   β”‚   β”œβ”€β”€ README.md                   # Project overview
β”‚   β”‚   └── WALKTHROUGH.md              # 8-hour guide
β”‚   └── README.md                       # Reference guide
β”‚
β”œβ”€β”€ dashboard/                           # Web dashboard (Beta)
β”‚   β”œβ”€β”€ backend/                        # Node.js/Express API
β”‚   β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”‚   β”œβ”€β”€ server.js
β”‚   β”‚   β”‚   └── routes/                 # API routes
β”‚   β”‚   └── package.json
β”‚   β”œβ”€β”€ frontend/                       # React/Vite app
β”‚   β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”‚   β”œβ”€β”€ pages/
β”‚   β”‚   β”‚   └── context/
β”‚   β”‚   └── package.json
β”‚   └── README.md                       # Dashboard docs
β”‚
β”œβ”€β”€ templates/                           # CI/CD templates
β”‚   └── github-actions/
β”‚       β”œβ”€β”€ saat-analysis.yml           # GitHub Action workflow
β”‚       └── README.md                   # Setup guide
β”‚
β”œβ”€β”€ completions/                         # Shell completions
β”‚   β”œβ”€β”€ saat-completion.bash            # Bash completion
β”‚   β”œβ”€β”€ saat-completion.zsh             # Zsh completion
β”‚   └── README.md                       # Installation guide
β”‚
β”œβ”€β”€ Dockerfile                           # Docker image
β”œβ”€β”€ docker-compose.yml                   # Docker Compose setup
β”œβ”€β”€ DOCKER.md                            # Docker documentation
β”œβ”€β”€ INSTALLATION.md                      # Installation guide
β”œβ”€β”€ AGENTS_GUIDE.md                      # Complete agents reference
β”œβ”€β”€ ROADMAP.md                           # Development roadmap
└── README.md                            # This file

πŸ—‘οΈ Uninstallation

If you need to remove SAAT agents:

Automated Uninstallation

cd SAAT-ClaudeCode
./scripts/uninstall.sh

The script will:

  • List all SAAT agents to be removed
  • Ask for confirmation
  • Remove all agents from ~/.claude/agents/

Manual Uninstallation

# Remove all SAAT agents
rm ~/.claude/agents/saat-*.md

# Or remove specific agent
rm ~/.claude/agents/saat-orchestrator.md

Verify Removal

ls ~/.claude/agents/saat-*.md
# Should return: No such file or directory

🀝 Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Development

To test agents locally before installation:

# Copy to project-specific directory
mkdir -p .claude/agents
cp agents/*.md .claude/agents/

πŸ“ License

MIT License - see LICENSE file for details.


πŸ™ Credits

Created by: David R. Oliver

Based on: Solution Architects Analysis Toolkit (SAAT) methodology

Powered by: Claude Code by Anthropic


πŸ“ž Support


🎯 Next Steps

  1. Install: Run ./scripts/install.sh
  2. Learn: Read AGENTS_GUIDE.md
  3. Try: Invoke saat-orchestrate in Claude Code
  4. Explore: Run saat-help for all commands

Ready to revolutionize your architecture analysis? Install SAAT and start architecting! πŸš€

./scripts/install.sh

Then in Claude Code:

Task(subagent_type="saat-help", prompt="Show me what you can do")

Happy architecting! πŸŽ‰

About

Sub agents in claude code

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors