Skip to main content

Miscellaneous

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

completion​

Generates a completion script for the Atym CLI for a given shell.

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

Flags:
  -h, --help   help for completion

Required: bash, zsh, fish, or powershell.

help​

Displays a list of available commands and their basic descriptions. This command can be used on its own to see all commands, or with a specific command to get detailed help for that command.

Usage:
  atym [command]

Available Commands:
  add         Add to a resource
  build       Builds a Atym container image based on the specified image definition file. 
  completion  Generate completion script
  help        Help about any command
  list        List details for specified resource
  login       Login to the Atym Orchestration Hub.
  logout      Log out of the Atym Hub
  push        Pushes the specified container image to the Atym Hub
  remove      Remove a specified resource
  run         Deploys the provided container images to the specified device
  set         Set a specified value in the configuration file.
  show        Show resource details
  version     Displays the version of the current CLI

Flags:
  -h, --help   help for atym

version​

Displays the version of the current CLI

Usage:
  atym version [flags]

Flags:
  -h, --help   help for version