Documentation

Installation

Get started with Cloud Blueprint in minutes using your preferred package manager.

npm install -g @cloudblueprint/cli

brew install cloudblueprint

docker pull cloudblueprint/cli:latest

Quick Start

Initialize your first infrastructure project in 3 simple steps.

cloudblueprint init my-infrastructure

cloudblueprint design --open

cloudblueprint deploy --env production

Design Infrastructure

Use the visual designer or write code directly. Both approaches generate the same IaC output.

Visual Designer

1. Launch designer: cloudblueprint design
2. Drag resources from the palette onto the canvas
3. Connect resources to define relationships
4. Configure properties in the inspector panel
5. Export to Terraform, CloudFormation, or Pulumi

Code-First Approach

Write infrastructure definitions in HCL, YAML, or TypeScript:

module "vpc" {
  source = "cloudblueprint/vpc"
  
  name = "production-vpc"
  cidr = "10.0.0.0/16"
  
  subnets = {
    public  = ["10.0.1.0/24", "10.0.2.0/24"]
    private = ["10.0.10.0/24", "10.0.11.0/24"]
  }
}

Create Policies

Define organizational standards as code using OPA Rego or our simplified DSL.

package cloudblueprint.security

deny[msg] {
  resource := input.resources[_]
  resource.type == "aws_s3_bucket"
  not resource.encryption_enabled
  
  msg := sprintf("S3 bucket %s must have encryption", [resource.name])
}

deny[msg] {
  resource := input.resources[_]
  resource.type == "aws_ec2_instance"
  not resource.tags.Environment
  
  msg := "All EC2 instances must have Environment tag"
}

Test policies before deployment:

cloudblueprint policy test ./policies

Monitor Drift

Enable continuous drift monitoring to maintain infrastructure integrity.

drift:
  enabled: true
  interval: "5m"
  auto_remediate: true
  notifications:
    - type: slack
      webhook: ${SLACK_WEBHOOK}
    - type: email
      recipients: ["devops@company.com"]

View drift reports:

cloudblueprint drift report --last 24h

API Reference

Integrate Cloud Blueprint into your applications using our REST API.

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.cloudblueprint.tech/v1/projects

Common Endpoints

• GET /v1/projects - List all projects
• POST /v1/projects - Create new project
• GET /v1/drift/reports - Get drift reports
• POST /v1/policies/validate - Validate against policies