Skip to main content

Containers

Container commands manage the containers currently deployed to a device. Use them to deploy a new container set with run, list the containers on a device with container list, or remove the container set with clear.

For commands that operate on images stored in the Hub (build, push, pull, image lifecycle), see Images.

run​

Deploy the provided images to the device container set. run replaces all existing containers on the device with the specified images. If the image tag is not specified, latest is used. The NAME field names the container — if not specified, the image name is used as the container name. Any number of containers can be deployed by repeating [ NAME IMAGE_REF[:TAG] ] pairs.

Usage:
  atymctl run [-d DEVICE_ID | -n DEVICE_NAME]  [ NAME IMAGE_REF[:TAG] ]

Flags:
  -c, --clear                  clear the container set of the device
  -d, --device string          device Id to deploy the container set to
  -h, --help                   help for run
  -n, --name string            device name to look up
  -v, --verbose                provide verbose output
  -w, --workload-type string   workload type: wasm, aot, or linux (default "wasm")

Examples:

# Uses the default device set in your config
atymctl run mycontainer1 myimage:latest mycontainer2 myimage2:latest

# Target a specific device by ID
atymctl run -d 12345678-1234-1234-1234-123456789012 mycontainer1 myimage:latest

# Target a device by name
atymctl run -n mydevice mycontainer1 myimage:latest mycontainer2 myimage2:latest

# Deploy a Linux workload
atymctl run -n mydevice -w linux mycontainer1 myimage:latest

Required: at least one NAME IMAGE_REF[:TAG] pair, plus a device (via --device, --name, or default-device config).

container list​

List the containers currently associated with a device.

Usage:
  atymctl container list [DEVICE_ID] [flags]

Flags:
  -h, --help          help for list
  -n, --name string   Device Name

Required: DEVICE_ID or --name. If both are omitted, the default device from your config is used.

clear​

Clear the container set on a device — removes all containers currently deployed.

Usage:
  atymctl clear [flags]

Flags:
  -d, --device string   device Id to deploy the container set to
  -h, --help            help for clear
  -n, --name string     device name to look up

Note: If no device is given, atymctl clear removes containers from the default device set in your config.