Overview

cloudburn init config

Generate a starter .cloudburn.yml configuration file.


Synopsis

cloudburn init config [--print]

Description

Generates a starter .cloudburn.yml configuration file at your git root. If you're not inside a git repository, the file is created in the current working directory.

The generated file includes both iac and discovery sections with all available keys commented out so you can enable only what you need.

If a .cloudburn.yml or .cloudburn.yaml already exists, the command exits with an error without overwriting it.

Flags

FlagTypeDefaultDescription
--printbooleanfalsePrint the generated YAML to stdout instead of writing a file. Useful for previewing or piping to another tool.

Generated output

Running cloudburn init config creates the following file:

iac:
  # enabled-rules:
  #   - CLDBRN-AWS-EBS-1
  # disabled-rules:
  #   - CLDBRN-AWS-EC2-2
  # services:
  #   - ebs
  #   - ec2
  # format: table

discovery:
  # enabled-rules:
  #   - CLDBRN-AWS-EBS-1
  # disabled-rules:
  #   - CLDBRN-AWS-S3-1
  # services:
  #   - ebs
  #   - s3
  # format: json

Examples

Write config to git root:

cloudburn init config

Preview config without writing:

cloudburn init config --print

What's next

ConfigurationFull reference for all config keys
cloudburn rules listFind rule IDs to use in enabled-rules
Quickstart: Scan IaC FilesRun your first scan with the config