BYaML — Cloud Architecture as Code

VS Code extension for .byaml files — the architecture-as-code format for cloud infrastructure.

Features

Syntax Highlighting

.byaml files get full syntax highlighting with special colors for:

• BYaML keywords (byamlVersion, architecture, components, finops)
• Component types (aws.lambda, aws.s3, gcp.functions, etc.)
• Environment constants (prod, staging, dev)

Snippets

Real-time Validation

Diagnostics appear as you type:

• ❌ Missing required fields (byamlVersion, architecture, components)
• ⚠️ Unknown component types not in the catalog

Autocomplete

Context-aware completions for:

• type: → all valid component types (aws.lambda, aws.s3, aws.dynamodb, etc.)
• layer: → compute, data, storage, network, edge, security, monitoring, integration
• environment: → prod, staging, dev, test, sandbox
• cloudProvider: → aws, azure, gcp, multi

Quick Start

1. Install the extension
2. Create a file with .byaml extension
3. Type byaml-init and press Tab

byamlVersion: "0.3"

architecture:
  id: my-app
  environment: prod
  cloudProvider: aws

components:
  - id: api-handler
    type: aws.lambda
    layer: compute
    props:
      runtime: python3.12
      memory: 256

What is BYaML?

BYaML is an architecture-as-code format that describes cloud infrastructure in a human-readable YAML format. It includes:

• Components — cloud resources with typed properties
• Relationships — connections between components
• FinOps — cost governance, budgets, and required tags
• Policies — validation rules for compliance

Schema: schema.byaml.org

Related

• byaml-finops-mcp — MCP server that generates .byaml files from your AWS account
• schema.byaml.org — Public schema API

License

MIT