Skip to main content
EXAMPLE

Init

Bootstrap a brand-new Atmos project from a built-in template in one command — no existing atmos.yaml required.

DX
cloudposse / atmos

Try it out

Copy the example into a new directory and make it your own:

atmos init examples/init
cd init

Follow the README for prerequisites and next steps.

See it in action

RECORDED DEMO
init
 
Recorded from this example
Real commands. Real output.
README.md2.6 KB
View on GitHub

Example: Init

Bootstrap a brand-new Atmos project from a built-in template.

Learn more in the Init Command Documentation.

What You'll See

  • Interactive and non-interactive atmos init usage
  • Generating atmos.yaml, stacks, and components from the basic template
  • Provisioning the generated project for real — atmos terraform apply on the greeting component, a local-only resource that needs no cloud account or emulator
  • Where to find the fuller catalog templates (aws/app, aws/landing-zone, gcp/landing-zone, azure/landing-zone)

Try It

# Interactive mode: prompts for a template and target directory
atmos init

# Non-interactive: generate the minimal "basic" template into ./my-project
atmos init basic ./my-project --set project_name=my-project

# See every available template, including remote and atmos.yaml-defined ones
atmos scaffold list

Key Templates

TemplatePurpose
basicMinimal, cloud-agnostic layout — atmos.yaml, one stack, and a real local greeting component (no cloud account needed)
simpleA slightly fuller starter project
atmosConvention-following full project skeleton
aws/appApplication SDLC repository for AWS (see examples/scaffolds/aws/app)
aws/landing-zoneAWS landing zone environments (see examples/scaffolds/aws/landing-zone)
gcp/landing-zoneGCP landing zone environments (see examples/scaffolds/gcp/landing-zone)
azure/landing-zoneAzure landing zone environments (see examples/scaffolds/azure/landing-zone)

How init relates to scaffold

atmos init is a thin, project-scoped specialization of the generic atmos scaffold code-generation engine — it always targets a whole new project directory and is meant to run once. For generating individual components, configs, or any other repeatable boilerplate inside an existing project, see examples/scaffolding and atmos scaffold generate.

Learn More