commands-reference.md5.2 KB
View on GitHubDevcontainer 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
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
--attach | Immediately attach after starting |
--identity | Atmos identity for credential injection |
Examples
atmos devcontainer start defaultatmos devcontainer start default --attachatmos devcontainer start default --instance aliceatmos devcontainer start default --identity prod-admin
atmos devcontainer stop
Stop a running devcontainer.
atmos devcontainer stop <name> [flags]
Flags
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
--timeout | Stop timeout duration |
--rm | Remove container after stopping |
Examples
atmos devcontainer stop defaultatmos devcontainer stop default --rmatmos devcontainer stop default --timeout 30s
atmos devcontainer attach
Attach to a running devcontainer for an interactive shell session.
atmos devcontainer attach <name> [flags]
Flags
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
--identity | Atmos identity for credential injection |
atmos devcontainer shell
Convenience command: start + attach in one step.
atmos devcontainer shell [name] [flags]
Flags
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
--new | Always create a new instance |
--replace | Replace existing instance |
--rm | Remove instance on exit |
--identity | Atmos identity for credential injection |
--pty | Enable PTY mode for interactive operations |
Examples
atmos devcontainer shell # Default devcontaineratmos devcontainer shell default # Named devcontaineratmos devcontainer shell default --new # Force new instanceatmos devcontainer shell default --rm # Remove on exitatmos 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
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
--identity | Atmos identity for credential injection |
Examples
atmos devcontainer exec default -- terraform planatmos devcontainer exec default -- aws sts get-caller-identityatmos devcontainer exec default -- env | grep AWSatmos 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
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
atmos devcontainer remove
Remove a devcontainer and its data.
atmos devcontainer remove <name> [flags]
Flags
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
atmos devcontainer logs
Show devcontainer logs.
atmos devcontainer logs <name> [flags]
Flags
| Flag | Description |
|---|---|
--instance | Instance name (default: "default") |
Configuration Schema
devcontainer:<name>:settings:runtime: docker|podman # Auto-detected if omittedspec:# Container imagename: "Display Name"image: "org/image:tag"# Build from Dockerfile (alternative to image)build:dockerfile: path/to/Dockerfilecontext: .args:KEY: value# WorkspaceworkspaceFolder: "/workspace"workspaceMount: "type=bind,source=${WORKSPACE},target=/workspace"# Additional mountsmounts:- "type=bind,source=${HOME}/.aws,target=/root/.aws,readonly"# NetworkingforwardPorts:- 8080- 3000portsAttributes:8080:label: "Web Server"# RuntimerunArgs:- "--privileged"containerEnv:KEY: valueremoteUser: "root"
Unsupported Spec Fields (Silently Ignored)
| Field | Workaround |
|---|---|
features | Install tools via image or Dockerfile |
postCreateCommand | Use Dockerfile RUN commands |
postStartCommand | Use atmos devcontainer exec |
customizations | Not applicable (Atmos is not VS Code) |
hostRequirements | Manage host requirements externally |