Skip to main content

Miscellaneous

Additional utility commands that support CLI functionality. These commands help with shell completion setup, version information, and discovering available commands.

completion​

Generates a shell completion script for atymctl. Source the output from your shell's startup file to enable tab-completion of atymctl commands and flags.

Usage:
  atymctl completion [bash|zsh|fish|powershell]

Flags:
  -h, --help   help for completion

Required: one of bash, zsh, fish, or powershell.

Example (bash):

# One-time setup
atymctl completion bash | sudo tee /etc/bash_completion.d/atymctl

# Or, for the current shell only
source <(atymctl completion bash)

help​

Display the list of available commands or detailed help for a specific command.

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

Pass --help to any command or subcommand for detailed usage:

atymctl device --help
atymctl device simulate start --help

version​

Display the version of the installed CLI.

Usage:
  atymctl version [flags]

Flags:
  -h, --help      help for version
  -v, --verbose   Display verbose version information