Skip to main content
commands-reference.md5.2 KB
View on GitHub

Devcontainer Commands Reference

Complete reference for all atmos devcontainer subcommands, flags, and usage patterns.

Note: The devcontainer feature is experimental.


atmos devcontainer list

List all configured devcontainers and their status.

atmos devcontainer list

atmos devcontainer config

Display the resolved devcontainer configuration.

atmos devcontainer config <name>

Examples

atmos devcontainer config default # Show default devcontainer config

atmos devcontainer start

Start a devcontainer, creating it if it does not exist.

atmos devcontainer start <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")
--attachImmediately attach after starting
--identityAtmos identity for credential injection

Examples

atmos devcontainer start default
atmos devcontainer start default --attach
atmos devcontainer start default --instance alice
atmos devcontainer start default --identity prod-admin

atmos devcontainer stop

Stop a running devcontainer.

atmos devcontainer stop <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")
--timeoutStop timeout duration
--rmRemove container after stopping

Examples

atmos devcontainer stop default
atmos devcontainer stop default --rm
atmos devcontainer stop default --timeout 30s

atmos devcontainer attach

Attach to a running devcontainer for an interactive shell session.

atmos devcontainer attach <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")
--identityAtmos identity for credential injection

atmos devcontainer shell

Convenience command: start + attach in one step.

atmos devcontainer shell [name] [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")
--newAlways create a new instance
--replaceReplace existing instance
--rmRemove instance on exit
--identityAtmos identity for credential injection
--ptyEnable PTY mode for interactive operations

Examples

atmos devcontainer shell # Default devcontainer
atmos devcontainer shell default # Named devcontainer
atmos devcontainer shell default --new # Force new instance
atmos devcontainer shell default --rm # Remove on exit
atmos devcontainer shell default -i prod-admin # With identity

atmos devcontainer exec

Execute a command inside a running devcontainer.

atmos devcontainer exec <name> [flags] -- <command> [args...]

Flags

FlagDescription
--instanceInstance name (default: "default")
--identityAtmos identity for credential injection

Examples

atmos devcontainer exec default -- terraform plan
atmos devcontainer exec default -- aws sts get-caller-identity
atmos devcontainer exec default -- env | grep AWS
atmos devcontainer exec default --instance alice -- bash -c "echo hello"

atmos devcontainer rebuild

Destroy and recreate a devcontainer from scratch.

atmos devcontainer rebuild <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")

atmos devcontainer remove

Remove a devcontainer and its data.

atmos devcontainer remove <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")

atmos devcontainer logs

Show devcontainer logs.

atmos devcontainer logs <name> [flags]

Flags

FlagDescription
--instanceInstance name (default: "default")

Configuration Schema

devcontainer:
<name>:
settings:
runtime: docker|podman # Auto-detected if omitted

spec:
# Container image
name: "Display Name"
image: "org/image:tag"

# Build from Dockerfile (alternative to image)
build:
dockerfile: path/to/Dockerfile
context: .
args:
KEY: value

# Workspace
workspaceFolder: "/workspace"
workspaceMount: "type=bind,source=${WORKSPACE},target=/workspace"

# Additional mounts
mounts:
- "type=bind,source=${HOME}/.aws,target=/root/.aws,readonly"

# Networking
forwardPorts:
- 8080
- 3000
portsAttributes:
8080:
label: "Web Server"

# Runtime
runArgs:
- "--privileged"
containerEnv:
KEY: value
remoteUser: "root"

Unsupported Spec Fields (Silently Ignored)

FieldWorkaround
featuresInstall tools via image or Dockerfile
postCreateCommandUse Dockerfile RUN commands
postStartCommandUse atmos devcontainer exec
customizationsNot applicable (Atmos is not VS Code)
hostRequirementsManage host requirements externally