Skip to content

quick_start.md

Latest commit

 

History

History
162 lines (112 loc) · 4.45 KB

quick_start.md

File metadata and controls

162 lines (112 loc) · 4.45 KB
Raw

Quick Start

Installation

pip install thothctl

Verify:

thothctl --version

Platform-Specific Notes

Guided Onboarding (Recommended First Step)

thothctl quickstart

The quickstart command walks you through initial setup interactively — detecting your environment, selecting a VCS provider, configuring your first space, and running a sample scan. It's the fastest way to get productive with ThothCTL.

Setup Autocomplete

thothctl-register-autocomplete

Configures PowerShell on Windows, Bash/Zsh/Fish on Linux/macOS.

Basic Usage

thothctl --help
Usage: thothctl [OPTIONS] COMMAND [ARGS]...

  ThothForge CLI - The Open Source Internal Developer Platform CLI

Options:
  --version                  Show the version and exit.
  --debug                    Enable debug mode
  -d, --code-directory PATH  Configuration file path
  --help                     Show this message and exit.

Getting Started:
  quickstart  Guided onboarding for new users
  init        Initialize and setup project configurations and environments

Security & Compliance:
  scan        Scan infrastructure code for security issues and compliance
  ai-review   AI-powered security analysis and code review for IaC
  check       Validate environment, IaC, cost analysis, and blast radius

Infrastructure Management:
  inventory   Create inventory for IaC composition with version tracking
  document    Generate documentation for IaC projects with AI support
  generate    Generate IaC from rules, use cases, and components

Workflow & Orchestration:
  workflow    Composable DevSecOps pipelines (devsecops, run)
  dashboard   Web dashboard for visualizing results
  mcp         Model Context Protocol (MCP) server for AI integration

Project Management:
  project     Convert, clean up and manage the current project
  list        List projects and spaces managed by thothctl locally
  remove      Remove projects and spaces managed by thothctl
  upgrade     Upgrade thothctl to the latest version

New in v0.25.0: Commands are now displayed in logical categories. The CLI also warns you on every invocation when a newer version is available.

Create a Space

Spaces organize your projects with shared configuration (VCS provider, registry, orchestration tool):

thothctl init space -vcs github -d "My infrastructure projects" -s my-space
✅ 🎉 Space 'my-space' initialized successfully!
💡 You can now create projects in this space with:
   thothctl init project --project-name <name> --space my-space

Create a Project

From a void template

thothctl init project --project-name my-project --space my-space

From an existing template (reuse)

Clone and customize a template from your GitHub/GitLab/Azure DevOps organization:

thothctl init project -reuse -s my-space -pj my-project

You'll be prompted to select a template and fill in project parameters (region, environment, backend config, etc.).

Scan for Security Issues

thothctl scan .

Runs Checkov (and optionally Trivy, KICS) against your IaC code and generates reports.

Check IaC Structure

# Validate project structure
thothctl check iac

# Cost analysis
thothctl check iac -type cost-analysis --recursive

# Drift detection
thothctl check iac -type drift --recursive

# Dump effective configuration (v0.25.0)
thothctl check config

Create Inventory

thothctl inventory iac --check-versions

Generates a professional report with module versions, provider tracking, and outdated dependency detection.

AI Security Review

# Analyze with local AI (no data leaves your machine)
thothctl ai-review analyze -d ./terraform -p ollama

# Multi-agent orchestrated review
thothctl ai-review orchestrate -d ./terraform -a security -a fix

Next Steps