Images

Image commands cover the full lifecycle of an Atym container image: building it locally, pushing it to the Atym Hub, pulling it back down, and inspecting or managing the images stored in your tenant's registry.

The image resource has aliases image and images and is used for commands that operate on images already stored in the Hub. The top-level commands build, push, and pull move images between your local environment and the Hub.

`build`

Build an Atym container image from a build definition file. If --filename is not provided, the command looks for build.yaml in the current working directory.

Usage:
  atymctl build [-f FILENAME]

Flags:
  -f, --filename string   image definition file (default "build.yaml")
  -h, --help              help for build
  -s, --skip-validation   skip validation of the buildfile
  -w, --skip-wasm         skip wasm compilation and validation entirely
  -v, --verbose           verbose output

`push`

Push the specified container image to the Atym Hub. You can optionally provide a description for the image and choose to keep the local zip file after upload. If you already have a built Atym zip package, upload it directly with --file.

Usage:
  atymctl push [-v] [IMAGE_NAME|IMAGE_NAME[:TAG] [-d "Image description"] [-k keep zip]

Flags:
  -a, --aotConfig string     AOT yaml configuration file
  -d, --description string   Package description
  -f, --file string          Specify zip file path to upload directly
  -h, --help                 help for push
  -k, --keep                 Do not delete upload zip file
  -v, --verbose              Verbose output

Required: IMAGE_NAME. If no tag is given, latest is assumed.

info

For details on the AOT configuration file used with --aotConfig, see AOT Compilation.

`pull`

Pull a container image from the Atym Hub or from a specified source registry (e.g. docker.io, quay.io, ghcr.io) and install it into the local OCI image store.

Usage:
  atymctl pull [flags]

Flags:
  -a, --architecture string   Target architecture for the image
  -h, --help                  help for pull
  -i, --imageName string      Name of the image to pull from Atym Hub
      --insecure              Allow pulling from insecure registries (HTTP)
  -o, --outputPath string     Root directory for the installed OCI image layout
  -p, --password string       Password for authenticating to the source registry
  -s, --source string         Source address to pull the image from (e.g., docker.io/quay.io/ghcr.io)
  -u, --username string       Username for authenticating to the source registry
  -v, --variant string        Target variant for the image

Required: --imageName. When pulling from a non-Atym registry, provide --source and, if required, --username/--password.

`image list`

List the images in a given repository. Results are paginated; use --tail to interactively page through all results.

Usage:
  atymctl image list [repository] [flags]

Flags:
  -h, --help              help for list
  -o, --page_offset int   Offset for paging
  -p, --page_size int     Number of results to return (default 20)
  -t, --tail              Interactively page through all results

Required: repository.

`image manifest`

Show the manifest of a container image in the Atym Hub. If the manifest returned is an index, it contains the list of all images in the repository — pass a SHA256 digest as the second argument to retrieve the manifest for a specific image.

Usage:
  atymctl image manifest [IMAGE_NAME[:TAG]] [SHA256] [flags]

Flags:
  -h, --help   help for manifest

Required: IMAGE_NAME. If no tag is provided, latest is used.

`image config`

Return the image configuration for a given repository and image SHA256.

Usage:
  atymctl image config [repository] [image_sha256] [flags]

Flags:
  -h, --help   help for config

Required: repository and image_sha256.

`image aot`

Add an AOT (Ahead-of-Time) compilation to an existing repository image. Equivalent to pushing with --aotConfig, but accepts the AOT parameters as command-line flags.

Usage:
  atymctl image aot [IMAGE_NAME[:TAG]] [flags]

Flags:
  -c, --cpu string         Device cpu type
  -e, --enableSharedHeap   Enable shared heap
  -p, --heapSize int       Heap size in bytes
  -h, --help               help for aot
  -s, --stackSize int      Stack size in bytes
  -t, --target string      Device architecture type
  -a, --targetAbi string   Device target ABI
  -x, --xip                XIP (Execute In Place) enabled

Required: IMAGE_NAME[:TAG] and --target. Additional requirements depend on your configuration:

For target-only: --target
For target + target-abi: --target and --targetAbi
For target + target-abi + cpu: --target, --targetAbi, and --cpu

Optional: --xip (can be used with any combination above)

Note: The compiler validates the combination of target and targetAbi. Invalid combinations return an error.

Accepted Values

Parameter	Description	Accepted Values
`cpu`	The device cpu type	See available CPU types
`target`	The device architecture type	See available Target types
`targetAbi`	The Application Binary Interface for the target platform	See available TargetAbi types

`image remove`

Delete an image from the registry.

Usage:
  atymctl image remove [flags]

Flags:
  -h, --help   help for remove

build​

push​

pull​

image list​

image manifest​

image config​

image aot​

Accepted Values​

image remove​