Skip to main content

Atym CLI

The Atym CLI is a command-line tool used for device and package management within the Atym ecosystem. It provides functionality for managing all aspects of your Atym deployment, from accounts and devices to containers and repositories.

Command Organization​

The CLI reference is organized into these main categories:

Usage​

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

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 container image to the specified device
 set         Set a specified value in the configuration file.
 show        Show resource details
 signup      Signup with the Atym Hub
 version     Displays the version of the current CLI
Flags:
 -h, --help   Help for atym
Use "atym [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. Create an account using atym signup.
  2. Log in using atym login.
  3. Use atym 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.