Skip to main content

Examples

Runnable configurations live under examples/ in the repository.

AWS CloudFormation Basic Example​

Minimal SQS deploy with no template parameters. Useful as a first end-to-end sandbox.

See aws-cloudformation-basic.

From the repository root:

pnpm install && pnpm build
pnpm sandbox:lint
pnpm sandbox:plan
pnpm sandbox:run

AWS CloudFormation Parameters Example​

Shows how to pass CloudFormation Parameters from stacktest.yaml, including dynamic $[stacktest_*] values and per-region overrides.

See aws-cloudformation-parameters.

pnpm install && pnpm build
pnpm sandbox:params:lint
pnpm sandbox:params:plan
# Cloud optional:
pnpm sandbox:params:run
# Local mock (no AWS):
node packages/cli/dist/index.js run --config examples/aws-cloudformation-parameters/stacktest.yaml --provider fake

Terraform Basic Example​

Local-friendly Terraform module using the null provider (no cloud credentials). Shows how StackTest parameters map to Terraform -var inputs.

See terraform-basic.

pnpm install && pnpm build
pnpm sandbox:tf:lint
pnpm sandbox:tf:plan
# Mock:
node packages/cli/dist/index.js run --config examples/terraform-basic/stacktest.yaml --provider fake
# Real Terraform CLI:
pnpm sandbox:tf:run
# Same config as JSON:
node packages/cli/dist/index.js lint --config examples/terraform-basic/stacktest.json

Multi-stage composition example​

Runnable offline demo of sequential stages and $[stage:name:OutputKey] wiring (uses the fake provider).

See multi-provider-composition.

pnpm install && pnpm build
pnpm sandbox:composition:lint
pnpm sandbox:composition:plan
pnpm sandbox:composition:run

The same stage syntax works across real providers when outputs match (for example Terraform → CloudFormation). See Configuration → Tests and Dynamic Values.