Skip to main content

atmos emulator up

Use this command to start (or reuse) the emulator's long-running container. The container is labeled by its canonical instance address and outlives the atmos process, so it stays available for subsequent commands.

By default the emulator persists its state across down/up by bind-mounting a host directory under the XDG cache ($XDG_CACHE_HOME/atmos/emulator/<instance>, overridable with ATMOS_XDG_CACHE_HOME) onto the emulator's data directory. Pass --ephemeral for a throwaway instance, or use atmos emulator reset to wipe persisted state.

atmos emulator up --help

Usage​

atmos emulator up <component> --stack <stack> [flags]

Examples​

# Start (or reuse) the aws emulator in the plat-ue2-dev stack
atmos emulator up aws --stack=plat-ue2-dev

# Start a throwaway instance that does not persist state
atmos emulator up aws --stack=plat-ue2-dev --ephemeral

# Using the emu alias
atmos emu up aws --stack=plat-ue2-dev

Arguments​

component
Required. The emulator component to start (for example, aws).

Flags​

-s, --stack
Required. The stack the emulator component belongs to (for example, plat-ue2-dev).
--ephemeral
Run without persisting state; data is discarded on down. Persistence is enabled by default, so this forces a throwaway instance for this up (overriding the component's ephemeral: config). Also settable with ATMOS_EMULATOR_EPHEMERAL=true.

Try it out​

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

atmos init examples/emulator-aws
cd emulator-aws

Requires Docker or Podman and network access for the image. Start the local AWS emulator, then stop and remove it when finished.

atmos emulator up aws -s local
atmos emulator down aws -s local
Explore the example →Initialization and repository settings

See Also​