thothctl

ThothCTL Use Cases

This directory contains comprehensive guides for using ThothCTL in real-world scenarios. Each use case demonstrates how ThothCTL enables modern infrastructure development workflows.

🎯 Featured Use Cases

🤖 AI-Powered Development Lifecycle (AI-DLC)

Complete AI-assisted IaC development workflow with Kiro CLI and MCP integration.

What you’ll learn:

• Integrate ThothCTL with AI assistants
• Use natural language for IaC operations
• AI-powered code review and documentation
• Two workflow options: AI orchestration vs. manual + AI analysis

Key Features:

• 26 MCP tools for AI integration
• Natural language interface
• Automated documentation generation
• Intelligent troubleshooting

---

🔒 DevSecOps SDLC Guide

8-phase DevSecOps lifecycle for Infrastructure as Code projects.

What you’ll learn:

• Complete DevSecOps workflow (Plan → Monitor)
• Security scanning at every phase
• AWS cost analysis and blast radius assessment
• CI/CD integration patterns

Key Features:

• Multi-tool security scanning (Checkov, Trivy, KICS, OPA)
• Real-time AWS cost estimation
• ITIL v4 change impact assessment
• Compliance enforcement

Quick Start: DevSecOps Quick Start Guide

---

📦 Space Management

Organize projects with logical boundaries and multi-tenancy support.

What you’ll learn:

• Create and manage spaces
• Separate dev/prod environments
• Manage credentials and configurations
• Multi-team collaboration

---

✅ Check Command

Validate environments, IaC, costs, and change impact.

What you’ll learn:

• Environment validation
• IaC validation and planning
• AWS cost analysis
• Blast radius assessment

---

📊 Inventory Command

Track dependencies and versions with professional reports.

What you’ll learn:

• Create IaC inventory
• Track module and provider versions
• Generate modern HTML reports
• Identify outdated dependencies

---

🚀 Quick Start Workflows

1. Bootstrap Complete Environment

# Install all development tools
thothctl init env

# Creates: Terraform, Terragrunt, OpenTofu, Checkov, Trivy, Kiro CLI, etc.

2. Create Project from Scaffold

# Create a space
thothctl init space --space-name lab-github

# Create project from template
thothctl init project --project-name my-infra --reuse --space lab-github

# Choose from official scaffolds:
# - terraform-scaffold
# - terragrunt-scaffold
# - tofu-scaffold
# - cdk-scaffold
# - cloudformation-scaffold

3. DevSecOps Workflow

# Full pipeline (all phases)
thothctl workflow devsecops --phase all

# Pre-deployment gate (test + secure)
thothctl workflow devsecops --phase pre-deploy --enforcement hard

# Individual phases
thothctl workflow devsecops --phase plan      # Cost + blast radius
thothctl workflow devsecops --phase develop   # Environment + structure + docs
thothctl workflow devsecops --phase build     # Inventory + versions
thothctl workflow devsecops --phase secure    # Checkov + Trivy + OPA
thothctl workflow devsecops --phase monitor   # Drift detection

# Or run individual commands directly:
thothctl check iac -type cost-analysis
thothctl scan iac -t checkov -t trivy
thothctl inventory iac --check-versions

4. AI-Assisted Development

# Start MCP server
thothctl mcp server

# In another terminal, use Kiro CLI
kiro-cli chat --agent thoth

# Example AI conversation:
# User: "Scan my Terraform code for security issues"
# AI: [Executes scan, analyzes results, suggests fixes]

📋 Command Categories

Initialization

• thothctl init env - Bootstrap development environment
• thothctl init space - Create logical space
• thothctl init project - Create project from scaffold

Validation & Analysis

• thothctl check environment - Validate tool versions
• thothctl check iac - Validate IaC configuration
• thothctl check iac -type cost-analysis - AWS cost estimation
• thothctl check iac -type blast-radius - Change impact assessment

Security & Compliance

• thothctl scan iac - Security scanning with Checkov (default)
• thothctl scan iac -t checkov -t trivy -t opa - Multi-tool scanning
• thothctl scan iac --enforcement hard - Fail pipeline on violations

Workflow (Composite Operations)

• thothctl workflow devsecops --phase all - Full DevSecOps pipeline
• thothctl workflow devsecops --phase secure - Security scanning phase
• thothctl workflow devsecops --phase pre-deploy - Pre-deployment gate (test + secure)
• thothctl workflow devsecops --phase plan - Cost estimation + blast radius
• thothctl workflow devsecops --enforcement hard - Block on violations

Documentation

• thothctl document iac - Generate documentation
• thothctl document iac --ai - AI-powered documentation

Dependency Management

• thothctl inventory iac - Create inventory
• thothctl inventory iac --check-versions - Module version tracking
• thothctl inventory iac --check-provider-versions - Provider version tracking
• thothctl inventory iac --report-type cyclonedx - Generate CycloneDX SBOM

Project Management

• thothctl project iac - Manage IaC projects
• thothctl list projects - List all projects
• thothctl remove project - Remove project

Code Generation

• thothctl generate stacks - Generate infrastructure stacks
• thothctl generate components - Generate components

AI Integration

• thothctl mcp server - Start MCP server for AI

Maintenance

• thothctl upgrade - Self-update ThothCTL

🎓 Learning Path

Beginner

1. Quick Start Guide
2. Space Management
3. DevSecOps Quick Start

Intermediate

1. DevSecOps SDLC Guide
2. Check Command
3. Inventory Command

Advanced

1. AI Development Lifecycle
2. Framework Architecture
3. Software Architecture

🔧 Integration Patterns

CI/CD Integration

GitHub Actions:

- name: Security Scan
  run: thothctl scan iac -t checkov -t trivy --enforcement hard --output sarif

- name: Cost Analysis
  run: thothctl check iac -type cost-analysis

GitLab CI:

security_scan:
  script:
    - thothctl scan iac -t checkov -t trivy --enforcement hard
    - thothctl check iac -type blast-radius

Pre-commit Hooks

# .pre-commit-config.yaml
- repo: local
  hooks:
    - id: thothctl-scan
      name: ThothCTL Security Scan
      entry: thothctl scan iac -t checkov
      language: system

AI-Powered Code Review

# Start MCP server for AI assistant integration
thothctl mcp server

# Or use the AI review directly
thothctl ai-review analyze -d ./terraform -p ollama

🏗️ Architecture Patterns

Multi-Environment Setup

organization/
├── spaces/
│   ├── dev/              # Development space
│   ├── staging/          # Staging space
│   └── prod/             # Production space
└── projects/
    ├── networking/       # Shared networking
    ├── compute/          # Compute resources
    └── data/             # Data infrastructure

Multi-Tool Projects

project/
├── terraform/            # Terraform IaC
├── terragrunt/          # Terragrunt configs
├── cloudformation/      # CloudFormation templates
└── cdk/                 # CDK code

🎯 Best Practices

Security

• ✅ Run security scans before every deployment
• ✅ Use compliance policies for governance
• ✅ Review high-severity issues immediately
• ✅ Integrate scanning into CI/CD pipelines

Cost Management

• ✅ Analyze costs before deployment
• ✅ Set budget alerts and thresholds
• ✅ Review cost optimization recommendations
• ✅ Tag resources for cost allocation

Documentation

• ✅ Generate documentation automatically
• ✅ Keep runbooks updated
• ✅ Use AI for comprehensive docs
• ✅ Version control documentation

Collaboration

• ✅ Use spaces for team separation
• ✅ Share scaffolds across teams
• ✅ Document custom workflows
• ✅ Standardize naming conventions

🔗 Related Resources

• Framework Architecture - Conceptual framework overview
• Software Architecture - Technical implementation
• Command Reference - Complete command documentation
• Template Engine - Template system guide
• Cross-Platform Support - Windows, Linux, macOS

💡 Need Help?

• Quick Start: 5-minute guide
• DevSecOps: Quick start or Complete guide
• AI Integration: AI-DLC guide
• Commands: Run thothctl <command> --help

🚀 What’s Next?

After mastering these use cases, explore:

• Custom scaffold creation
• Organization-specific templates
• Custom security policies
• Advanced CI/CD integration
• Multi-cloud deployments

This site is open source. Improve this page.