Atym CLI

The Atym CLI (atymctl) is a command-line tool for device and package management within the Atym ecosystem. It manages all aspects of your Atym deployment — accounts and tenants, devices, container images, and large-scale rollouts.

---

Command Organization

The CLI reference is organized into these main categories:

• Commands: All available CLI commands, grouped by resource
• Installation: How to install and upgrade atymctl
• Architecture & Targets: Accepted architecture and target parameter values
• AOT Compilation: Ahead-of-Time compilation workflow
• Device Configuration File: YAML format for device add -f
• Default Device Configuration: Setting a default device to simplify commands

---

Usage

The CLI provides a built-in help system to display available commands, sub-commands, and their associated parameters and flags.

Usage:
  atymctl [command]

Available Commands:
  account     Manage accounts
  build       Builds an Atym container image based on the specified image definition file
  campaign    Manage campaigns
  clear       Clears the container set of a device
  completion  Generate completion script
  config      Manage the local CLI configuration file
  container   Manage containers
  device      Manage devices
  help        Help about any command
  image       Manage container images
  login       Login to the Atym Orchestration Hub
  logout      Log out of the Atym Hub
  ota         Manage OTA updates
  pull        Pull an image and install it as a local OCI layout
  push        Pushes the specified container image to the Atym Hub
  repository  Manage repositories
  run         Deploys the provided container images to the specified device
  tenant      Manage tenants
  version     Displays the version of the current CLI

Flags:
  -h, --help   help for atymctl

Use "atymctl [command] --help" for more information about a command.

info

You must be logged into the Atym Hub to see all available commands. See the authentication page for more details about the login process.

---

Getting Started

To begin using the Atym CLI:

1. Install atymctl — see Installation.
2. Log in using atymctl login.
3. (Optional) Set a default device with atymctl config set-device so subsequent commands don't need a --device flag.
4. Use atymctl help or refer to the documentation sections for specific commands.

Each section in the sidebar provides detailed information about commands within that category, including usage examples and available options.