thothctl 0.24.3__tar.gz → 0.24.4__tar.gz

thothctl-0.24.4/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.1.11
+  hooks:
+    # Run the linter (includes import sorting with --fix).
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+
+#-   repo: https://github.com/PyCQA/bandit
+#    rev: 1.7.6
+#    hooks:
+#    - id: bandit
+
+
+#   repo: https://github.com/Lucas-C/pre-commit-hooks-safety
+#   rev: v1.7.2
+#   hooks:
+#   -   id: python-safety-dependencies-check
+#       args: [check, --full-report, --file]
+
+-   repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.3.0
+    hooks:
+    -   id: pydocstyle

thothctl-0.24.4/.pydocstyle

@@ -0,0 +1,15 @@
+[pydocstyle]
+# Use Google convention as baseline.
+convention = google
+# Ignore:
+# D100-D107: Missing docstrings (adopt incrementally)
+# D200: One-line docstring should not occupy multiple lines
+# D202: No blank lines allowed after function docstring
+# D205: 1 blank line required between summary and description
+# D209: Multi-line docstring closing quotes on separate line
+# D212: Multi-line docstring summary should start at the first line
+# D403: First word should be properly capitalized
+# D415: First line should end with a period/question/exclamation
+# D417: Missing argument descriptions in docstring
+# D419: Docstring is empty
+add_ignore = D100,D101,D102,D103,D104,D105,D107,D200,D202,D205,D209,D212,D403,D415,D417,D419

thothctl-0.24.4/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.4
+Name: thothctl
+Version: 0.24.4
+Summary: A CLI for Developer Control Plane. Accelerate your cloud IaC deployments.
+Project-URL: SourceCode, https://github.com/thothforge/thothctl
+Project-URL: HomePage, https://github.com/thothforge/thothctl
+Author-email: Alejandro Velez <velez94@pm.me>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: argcomplete>=3.4.0
+Requires-Dist: argparse>=1.4.0
+Requires-Dist: azure-devops==7.1.0b4
+Requires-Dist: bc-python-hcl2>=0.4.2
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: checkov==3.2.451
+Requires-Dist: click>=8.0.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: gitdb>=4.0.11
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: inquirer>=3.3.0
+Requires-Dist: json2html>=1.3.0
+Requires-Dist: junit2html>=30.1.3
+Requires-Dist: junitparser>=2.0.0
+Requires-Dist: mcp>=1.9.4
+Requires-Dist: pre-commit>=3.7.1
+Requires-Dist: psutil
+Requires-Dist: pyfiglet>=1.0.2
+Requires-Dist: pymsteams>=0.2.2
+Requires-Dist: pytest-cov>=5.0.0
+Requires-Dist: pytest>=8.2.2
+Requires-Dist: pywin32>=306; sys_platform == 'win32'
+Requires-Dist: pyyaml<7.0.0,>=6.0.0
+Requires-Dist: requests
+Requires-Dist: rich>=13.7.1
+Requires-Dist: terraform-compliance>=1.3.48
+Requires-Dist: toml>=0.10.2
+Requires-Dist: uvicorn>=0.24.0
+Requires-Dist: xmltodict>=0.13.0
+Requires-Dist: zipp>=3.19.2
+Provides-Extra: telemetry
+Requires-Dist: opentelemetry-api>=1.20.0; extra == 'telemetry'
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.20.0; extra == 'telemetry'
+Requires-Dist: opentelemetry-instrumentation-logging>=0.41b0; extra == 'telemetry'
+Requires-Dist: opentelemetry-sdk>=1.20.0; extra == 'telemetry'
+Description-Content-Type: text/markdown
+
+[![Publish Python Package](https://github.com/thothforge/thothctl/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thothforge/thothctl/actions/workflows/python-publish.yml)
+[![Documentation](https://github.com/thothforge/thothctl/actions/workflows/docs.yml/badge.svg)](https://thothforge.github.io/thothctl/)
+[![PyPI version](https://img.shields.io/pypi/v/thothctl)](https://pypi.org/project/thothctl/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
+
+# ThothCTL
+
+**AI-Powered Infrastructure Lifecycle CLI** for DevSecOps, Platform Engineering, and IaC governance.
+
+![ThothCTL](./docs/img/framework/thothctl_mcp.png)
+
+ThothCTL accelerates the adoption of Internal Developer Platforms by combining security scanning, inventory management, cost analysis, AI-driven code review, and organizational policy enforcement into a single CLI.
+
+## Quick Start
+
+```bash
+pip install --upgrade thothctl
+
+# Scan for security issues
+thothctl scan iac -t checkov -t trivy -t opa
+
+# Create infrastructure inventory (SBOM)
+thothctl inventory iac --check-versions
+
+# Launch web dashboard
+thothctl dashboard launch
+
+# AI-powered security review
+thothctl ai-review analyze -d ./terraform -p ollama
+```
+
+## Key Features
+
+### 🔒 Security Scanning
+
+Multi-tool scanning with unified HTML reports and enforcement:
+
+```bash
+# All scanners with hard enforcement (fails pipeline on violations)
+thothctl scan iac -t checkov -t trivy -t kics -t opa -t terraform-compliance --enforcement hard
+```
+
+- **5 integrated tools**: Checkov, Trivy, KICS, OPA/Conftest, Terraform-compliance
+- **Unified HTML reports** with severity badges, per-stack breakdown
+- **Non-compliance findings table** on enforcement failure
+- **SARIF output** for GitHub Code Scanning integration
+- **Organization policy repos** via `THOTH_ORG_POLICY` env var (HCL + CloudFormation)
+- **Scan trend tracking** with local SQLite history
+
+### 📦 Infrastructure Inventory (SBOM)
+
+CycloneDX 1.6 compliant Software Bill of Materials:
+
+```bash
+thothctl inventory iac --check-versions
+```
+
+- **Module & provider version tracking** with staleness detection
+- **CycloneDX 1.6 SBOM** with formulation, evidence, standards, attestations, dependency graph, hashes, and licenses
+- **Technical debt scoring** with risk levels and recommendations
+- **Schema compatibility analysis** for safe upgrades
+- **Professional HTML reports** with collapsible stack groups
+
+### 📊 Web Dashboard
+
+Modern FastAPI-based dashboard with dark mode:
+
+```bash
+thothctl dashboard launch
+```
+
+- **Security findings viewer** — filter by tool/severity/search, pagination, inline report iframe
+- **SBOM details browser** — CycloneDX metadata, dependency graph, formulation, attestations
+- **Inventory explorer** — collapsible stacks, module/provider tabs, version comparison
+- **Cost analysis** — service breakdown, monthly/annual projections
+- **Drift detection** — severity-classified drifted resources
+- **AI usage tracking** — token counts, costs per request
+
+### 🤖 AI Agent for IaC Security
+
+Multi-agent system for automated code review and PR decisions:
+
+```bash
+thothctl ai-review analyze -d ./terraform -p ollama
+thothctl ai-review decide -d ./terraform --pr-number 42 --dry-run
+```
+
+- **4 specialized agents**: Security, Architecture, Fix, Decision
+- **Multi-provider**: OpenAI, AWS Bedrock, Azure OpenAI, Ollama (local)
+- **Auto-decisions** with confidence thresholds and safety controls
+- **Adaptive memory**: filesystem or S3 (auto-detects runtime)
+- **MCP integration** for AI assistant interoperability
+
+### 💰 Cost Analysis & Risk Assessment
+
+```bash
+thothctl check iac -type cost-analysis --recursive
+thothctl check iac -type blast-radius --recursive
+thothctl check iac -type drift --recursive
+```
+
+- **14 AWS services** supported (EC2, RDS, S3, Lambda, EKS, etc.)
+- **Blast radius** with ITIL v4 risk classification
+- **Drift detection** with severity scoring and IaC coverage tracking
+
+### 🔄 Template Engine & Project Management
+
+```bash
+thothctl project convert --make-template --template-project-type terraform
+thothctl init project --name my-infra --template terraform-aws
+```
+
+- **Bidirectional conversion** between projects and reusable templates
+- **Backstage integration** for self-service consumption
+- **Template upgrade workflow** to keep projects in sync
+
+## All Commands
+
+| Command | Description |
+|---------|-------------|
+| `scan iac` | Multi-tool security scanning with enforcement |
+| `inventory iac` | Infrastructure SBOM with version tracking |
+| `check iac` | Cost analysis, blast radius, drift detection, structure validation |
+| `ai-review` | AI-powered security analysis and PR decisions |
+| `dashboard launch` | Web dashboard for all reports |
+| `document iac` | Auto-generate documentation |
+| `project convert` | Template ↔ project conversion |
+| `init project` | Scaffold new IaC projects |
+| `mcp` | Model Context Protocol server |
+| `generate` | Generate IaC from rules and components |
+
+## Installation
+
+```bash
+pip install --upgrade thothctl
+```
+
+**Requirements**: Python 3.10+ | Linux, macOS, or Windows (WSL)
+
+**Optional system packages**:
+```bash
+# Linux/Debian
+sudo apt install graphviz libgraph-easy-perl -y
+
+# macOS
+brew install graphviz graph-easy
+```
+
+### Dev Container
+
+A ready-to-use [Dev Container](.devcontainer/) is available with all tools pre-configured:
+
+```bash
+# Open in VS Code → "Reopen in Container"
+# Or use the devcontainer CLI:
+devcontainer up --workspace-folder .
+```
+
+## Documentation
+
+📖 **Full docs**: [thothforge.github.io/thothctl](https://thothforge.github.io/thothctl/)
+
+- [Quick Start](docs/quick_start.md)
+- [DevSecOps SDLC Guide](docs/framework/use_cases/devsecops_sdlc.md)
+- [Scan Command Reference](docs/framework/commands/scan/scan_overview.md)
+- [Inventory & SBOM](docs/framework/commands/inventory/inventory_overview.md)
+- [Dashboard](docs/dashboard/README.md)
+- [AI Review](docs/framework/commands/ai-review/README.md)
+- [Template Engine](docs/template_engine/template_engine.md)
+- [Dev Container Setup](docs/installation/devcontainer_setup.md)
+
+## CI/CD Integration
+
+```yaml
+# GitHub Actions
+- name: Security scan
+  run: thothctl scan iac -t checkov -t trivy -t opa --enforcement hard --post-to-pr
+
+- name: Inventory check
+  run: thothctl inventory iac --check-versions --report-type json
+```
+
+## Roadmap
+
+- [x] Multi-tool security scanning with unified reports
+- [x] AI Agent for IaC Security (multi-agent, auto-decisions)
+- [x] CycloneDX 1.6 SBOM with full supply chain metadata
+- [x] Organization policy engine (OPA/Rego, HCL + CloudFormation)
+- [x] Web Dashboard with findings viewer and SBOM browser
+- [ ] Intent-to-IaC generation (natural language → governed Terraform)
+- [ ] Composable workflow engine (declarative YAML DAG pipelines)
+- [ ] Graph-aware state visibility (tfstate → queryable resource graph)
+- [ ] Architecture diagram generation (Mermaid/Graphviz from IaC)
+- [ ] Strands Agents SDK integration
+
+📖 [Full Roadmap](docs/framework/roadmap_fdi.md)
+
+## Contributing
+
+Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+[Apache-2.0](LICENSE)

thothctl-0.24.4/docs/framework/framework_architecture.md

@@ -0,0 +1,358 @@
+# ThothCTL Framework Architecture
+
+> **Note**: This document provides a high-level overview of the framework architecture. For technical implementation details, see [Software Architecture](software_architecture.md).
+
+## Overview
+
+ThothCTL is an Internal Developer Platform (IDP) framework built on a **4-layer architecture** that enables teams to build, manage, and operate infrastructure as code with built-in best practices, security, and AI assistance.
+
+```mermaid
+%%{init: {'theme':'base', 'themeVariables': {
+  'primaryColor':'#3b82f6',
+  'primaryTextColor':'#ffffff',
+  'primaryBorderColor':'#2563eb',
+  'lineColor':'#94a3b8',
+  'secondaryColor':'#10b981',
+  'tertiaryColor':'#8b5cf6',
+  'background':'transparent',
+  'mainBkg':'#3b82f6',
+  'secondBkg':'#10b981',
+  'tertiaryBkg':'#8b5cf6',
+  'clusterBkg':'rgba(241, 245, 249, 0.05)',
+  'clusterBorder':'#475569',
+  'titleColor':'currentColor',
+  'edgeLabelBackground':'transparent',
+  'nodeTextColor':'#ffffff',
+  'textColor':'currentColor',
+  'nodeBorder':'#1e293b',
+  'fontSize':'14px'
+}}}%%
+graph TB
+    subgraph layer4["<b>🎨 Developer Experience Layer</b><br/><i>Intuitive interfaces and AI assistance</i>"]
+        direction LR
+        CLI["<b>CLI Interface</b><br/>Rich terminal UI<br/>Autocompletion<br/>Cross-platform"]
+        AI["<b>AI Assistant</b><br/>Kiro CLI + MCP<br/>Natural language<br/>24 AI tools"]
+        SKILLS["<b>Skills</b><br/>Reusable knowledge<br/>Decision logic<br/>Remediation"]
+        DOCS["<b>Documentation</b><br/>Auto-generation<br/>AI-powered<br/>Multi-format"]
+        TMPL["<b>Templates</b><br/>Jinja2 engine<br/>Code generation<br/>Scaffolding"]
+    end
+    
+    subgraph layer3["<b>⚡ Platform Capabilities Layer</b><br/><i>Core IDP functionality</i>"]
+        direction LR
+        SEC["<b>Security</b><br/>Checkov • Trivy<br/>KICS • OPA<br/>Compliance"]
+        COST["<b>Cost Analysis</b><br/>Real-time pricing<br/>14 AWS services<br/>Optimization"]
+        INV["<b>Inventory</b><br/>Dependencies<br/>Version tracking<br/>Reports"]
+        VAL["<b>Validation</b><br/>Environment<br/>IaC checks<br/>Blast radius"]
+        GEN["<b>Generation</b><br/>Stacks<br/>Components<br/>Boilerplate"]
+        WF["<b>Workflow</b><br/>DevSecOps SDLC<br/>Phase orchestration<br/>Enforcement gates"]
+        POL["<b>Policy</b><br/>OPA/Rego<br/>Org policies<br/>Remote repos"]
+    end
+    
+    subgraph layer2["<b>🔧 IaC Tool Integration Layer</b><br/><i>Multi-tool support through parsers and CLI</i>"]
+        direction LR
+        TF["<b>Terraform</b><br/>HCL Parser<br/>CLI Execution"]
+        TG["<b>Terragrunt</b><br/>Parser Class<br/>CLI Execution"]
+        TOFU["<b>OpenTofu</b><br/>HCL Parser<br/>CLI Execution"]
+        CFN["<b>CloudFormation</b><br/>JSON/YAML<br/>AWS API"]
+        CDK["<b>CDK v2</b><br/>Synth Parser<br/>CLI Execution"]
+    end
+    
+    subgraph layer1["<b>🏗️ Foundation Layer</b><br/><i>Building blocks for the framework</i>"]
+        direction LR
+        SCAFFOLD["<b>Git Scaffolds</b><br/>Templates<br/>Best practices<br/>Reusable"]
+        SPACE["<b>Spaces</b><br/>Multi-tenancy<br/>Credentials<br/>Isolation"]
+        ENV["<b>Environment</b><br/>Tool bootstrap<br/>Cross-platform<br/>Automated"]
+        CONFIG["<b>Configuration</b><br/>Hierarchical<br/>TOML format<br/>Overrides"]
+    end
+    
+    CLI -.->|uses| SEC
+    AI -.->|orchestrates| GEN
+    DOCS -.->|leverages| TMPL
+    
+    SEC -.->|scans| TF
+    COST -.->|analyzes| TG
+    INV -.->|tracks| TOFU
+    VAL -.->|validates| CFN
+    GEN -.->|generates| CDK
+    WF -.->|orchestrates| SEC
+    POL -.->|enforces| TF
+    
+    TF -.->|uses| SCAFFOLD
+    TG -.->|operates in| SPACE
+    TOFU -.->|requires| ENV
+    CFN -.->|reads| CONFIG
+    CDK -.->|uses| SCAFFOLD
+
+    SKILLS -.->|guides| AI
+    
+    classDef layer4Style fill:#3b82f6,stroke:#60a5fa,stroke-width:3px,color:#fff
+    classDef layer3Style fill:#10b981,stroke:#34d399,stroke-width:3px,color:#fff
+    classDef layer2Style fill:#8b5cf6,stroke:#a78bfa,stroke-width:3px,color:#fff
+    classDef layer1Style fill:#f59e0b,stroke:#fbbf24,stroke-width:3px,color:#fff
+    
+    class CLI,AI,SKILLS,DOCS,TMPL layer4Style
+    class SEC,COST,INV,VAL,GEN,WF,POL layer3Style
+    class TF,TG,TOFU,CFN,CDK layer2Style
+    class SCAFFOLD,SPACE,ENV,CONFIG layer1Style
+```
+
+## Framework Principles
+
+ThothCTL aligns with IDP business objectives through five core principles:
+
+| Principle | Mechanism | Implementation |
+|-----------|-----------|----------------|
+| **Minimize Mistakes** | Meaningful defaults | Templates & scaffolds |
+| **Increase Velocity** | Automation | IaC scripts & workflows |
+| **Improve Products** | Fill product gaps | New components & tools |
+| **Enforce Compliance** | Restrict choices | Wrappers & policies |
+| **Reduce Lock-in** | Abstraction | Service layers & adapters |
+
+## Architecture Layers
+
+### Layer 1: Foundation Layer 🏗️
+
+**Building blocks for the framework**
+
+| Component | Purpose | Key Features |
+|-----------|---------|--------------|
+| **Git Scaffolds** | Project templates | Pre-configured structures, best practices, rapid creation |
+| **Spaces** | Multi-tenancy | VCS integration, credential isolation, project organization |
+| **Environment** | Tool bootstrap | Automated setup, version management, cross-platform |
+| **Configuration** | Settings management | Hierarchical TOML, environment overrides, secure credentials |
+
+**Official Scaffolds:**
+- [terraform-scaffold](https://github.com/thothforge/terraform_project_scaffold) - Standard Terraform projects
+- [terragrunt-scaffold](https://github.com/thothforge/terragrunt_project_scaffold) - Multi-environment Terragrunt
+- [terraform-module-scaffold](https://github.com/thothforge/terraform_module_scaffold) - Reusable modules
+
+**Commands:** `thothctl init env`, `thothctl init space`, `thothctl init project`
+
+---
+
+### Layer 2: IaC Tool Integration Layer 🔧
+
+**Multi-tool support through parsers and CLI wrappers**
+
+| Tool | Parser | Execution | Status |
+|------|--------|-----------|--------|
+| **Terraform** | HCL Parser | CLI Wrapper | ✅ Full Support |
+| **Terragrunt** | Custom Parser | CLI Wrapper | ✅ Full Support |
+| **OpenTofu** | HCL Parser | CLI Wrapper | ✅ Full Support |
+| **CloudFormation** | JSON/YAML | AWS API | ✅ Full Support |
+| **CDK v2** | Synth Parser | CLI Wrapper | ✅ Full Support |
+
+**Key Features:**
+- Unified interface across tools
+- Tool-agnostic workflows
+- Version management
+- Execution orchestration
+
+**Commands:** `thothctl project iac`, `thothctl generate`
+
+---
+
+### Layer 3: Platform Capabilities Layer ⚡
+
+**Core IDP functionality**
+
+#### Security & Compliance
+Multi-tool security scanning with Checkov, Trivy, KICS, and Snyk.
+
+
+📖 **Details:** [Security Scanning](commands/scan/scan_overview.md)
+
+#### Cost Analysis
+Real-time AWS cost estimation with 14 services, automated HTML/JSON reports.
+
+**Commands:** `thothctl check iac -type cost-analysis`
+
+📖 **Details:** [Cost Analysis](commands/check/cost-analysis.md)
+
+#### Inventory Management
+Dependency tracking, version checking, professional HTML reports.
+
+**Commands:** `thothctl inventory iac --check-versions`
+
+📖 **Details:** [Inventory Management](commands/inventory/inventory_overview.md)
+
+#### Validation
+Environment validation, IaC checks, blast radius analysis.
+
+**Commands:** `thothctl check environment`, `thothctl check iac -type blast-radius`
+
+📖 **Details:** [Validation](commands/check/check_overview.md)
+
+#### Code Generation
+Stack generation, component creation, boilerplate automation.
+
+**Commands:** `thothctl generate`
+
+📖 **Details:** [Code Generation](commands/generate/generate_stacks.md)
+
+#### Workflow Engine
+Composite DevSecOps pipeline orchestration — chains multiple commands into SDLC phases with enforcement gates and live progress.
+
+**Phases:** plan → develop → build → test → secure → deploy → monitor
+
+**Commands:** `thothctl workflow devsecops --phase all`, `--phase secure`, `--phase pre-deploy`
+
+📖 **Details:** [Workflow Command](commands/workflow/workflow_overview.md) | [DevSecOps SDLC](use_cases/devsecops_sdlc.md)
+
+#### Policy as Code
+Organization-level governance via OPA/Rego policies distributed from centralized Git repositories.
+
+**Features:**
+- Remote policy repos (GitHub, Azure DevOps, GitLab)
+- Auto-cloning and caching
+- Multi-IaC support (HCL + CloudFormation policies)
+- Parameterized configs (config.yaml → data namespace)
+
+**Commands:** `thothctl scan iac -t opa --policy-dir <git-url>`
+
+📖 **Details:** [Policy as Code](policy_as_code.md)
+
+---
+
+### Layer 4: Developer Experience Layer 🎨
+
+**Intuitive interfaces and AI assistance**
+
+#### CLI Interface
+Rich terminal UI with autocompletion, cross-platform support, and modern UX.
+
+**Features:**
+- Click-based command structure
+- Rich console output
+- Shell autocompletion (bash, zsh, fish)
+- Progress indicators and spinners
+
+#### AI Assistant (Kiro CLI)
+Amazon Q integration with 19 specialized tools via Model Context Protocol (MCP).
+
+**Capabilities:**
+- Natural language infrastructure queries
+- Code generation and modification
+- Documentation generation
+- Cost analysis assistance
+- DevSecOps workflow orchestration via `thothctl_workflow_devsecops` MCP tool
+
+📖 **Details:** [AI-Powered Development](use_cases/ai_dlc.md)
+
+#### Skills System
+Reusable knowledge packages (`.kiro/skills/`) that teach AI agents domain-specific procedures, decision logic, and remediation patterns.
+
+**Bundled Skills:**
+- `devsecops` — DevSecOps SDLC orchestration, intent routing, remediation patterns
+- `terraform-skill` — Terraform/Terragrunt patterns, module design, state management
+- `iac-versioning-commits` — Conventional commits and versioning for IaC
+
+**Structure:**
+```
+.kiro/skills/<skill-name>/
+├── SKILL.md              # Decision logic, procedures, response patterns
+└── references/           # Domain knowledge (commands, fixes, templates)
+```
+
+**Distribution:** Skills are included in scaffold templates and distributed to new projects automatically.
+
+📖 **Details:** [DevSecOps Skill](https://github.com/thothforge/thothctl-devsecops-skill)
+
+#### Documentation Generation
+Automated documentation with AI-powered content generation.
+
+**Commands:** `thothctl document iac`, `thothctl document iac --ai`
+
+📖 **Details:** [Documentation](commands/document/document_overview.md)
+
+#### Template Engine
+Jinja2-based code generation with scaffolding support.
+
+**Features:**
+- Variable substitution
+- Conditional logic
+- Loops and filters
+- Custom functions
+
+📖 **Details:** [Template Engine](../template_engine/template_engine.md)
+
+---
+
+## Use Cases
+
+ThothCTL supports comprehensive IDP workflows:
+
+| Use Case | Commands | Documentation |
+|----------|----------|---------------|
+| **Project Initialization** | `init env`, `init space`, `init project` | [Getting Started](use_cases/README.md) |
+| **DevSecOps Pipeline** | `workflow devsecops --phase all` | [DevSecOps SDLC](use_cases/devsecops_sdlc.md) |
+| **Security Scanning** | `scan iac -t checkov -t trivy -t opa` | [Security](commands/scan/scan_overview.md) |
+| **Policy Enforcement** | `scan iac -t opa --policy-dir <url>` | [Policy as Code](policy_as_code.md) |
+| **Cost Analysis** | `check iac -type cost-analysis` | [Cost Analysis](commands/check/cost-analysis.md) |
+| **Dependency Management** | `inventory iac --check-versions` | [Inventory](commands/inventory/inventory_overview.md) |
+| **Drift Detection** | `check iac -type drift` | [Check Command](commands/check/check_overview.md) |
+| **Documentation** | `document iac --ai` | [Documentation](commands/document/document_overview.md) |
+| **AI Development** | Kiro CLI + MCP + Skills | [AI-DLC](use_cases/ai_dlc.md) |
+| **Observability** | `dashboard launch` | [Dashboard](commands/dashboard/dashboard_overview.md) |
+
+📖 **Complete Use Cases:** [Use Cases Documentation](use_cases/README.md)
+
+---
+
+## Integration Points
+
+### Version Control Systems
+- GitHub (OAuth, Personal Access Tokens)
+- GitLab (OAuth, Personal Access Tokens)
+- Azure DevOps (Personal Access Tokens)
+
+### Cloud Providers
+- AWS (IAM credentials, SSO)
+- Azure (Service Principal)
+- GCP (Service Account)
+
+### CI/CD Platforms
+- GitHub Actions
+- GitLab CI
+- Azure Pipelines
+- Jenkins
+
+### AI Services
+- Amazon Q (via Kiro CLI)
+- Model Context Protocol (MCP)
+
+---
+
+## Configuration Hierarchy
+
+```
+1. Global Config      (~/.thothctl/config.toml)
+2. Space Config       (.thothcf-<space>.toml)
+3. Project Config     (.thothcf.toml)
+4. Environment Vars   (THOTHCTL_*)
+```
+
+**Example Configuration:**
+```toml
+[project]
+name = "my-infrastructure"
+type = "terraform"
+
+[space]
+name = "lab-github"
+vcs = "github"
+
+[tools]
+terraform_version = "1.6.0"
+terragrunt_version = "0.54.0"
+```
+
+---
+
+## Next Steps
+
+- **Getting Started:** [Quick Start Guide](../quick_start.md)
+- **Commands Reference:** [Commands Documentation](commands/)
+- **Use Cases:** [Use Cases & Examples](use_cases/)
+- **Technical Details:** [Software Architecture](software_architecture.md)
+- **Template Engine:** [Template System](../template_engine/template_engine.md)