Skip to main content

CLI Automation

This chapter describes features of the CLI that allow you to automate its usage.

An example usage would be a CI/CD pipeline for deploying a new game version to production.

caution

The interface of Elympics CLI is a subject to rapid change as the tool is in active development. Use it with caution in your scripts.

Change config location

The --config option allows you to specify an alternative config file path.

This is helpful when you need to use multiple accounts.

Example:

elympics --config ./elympics-config.json auth login -u <username> -p <password>

Skipping prompts

In some commands you may be asked to provide a password interactively through the console. For non-interactive environments, the following alternatives are provided:

  • redirecting the password to the command:
elympics auth login -u automated-account << password.txt  # from file
get-password | elympics auth login -u automated-account # from another command
  • using the password directly as an argument:
elympics auth login -u automated-account -p <password here>

Docker image

For CI environments it's highly suggested to use our docker image which has the tool pre-installed.

caution

Using the latest tag may result in errors when a breaking change enters CLI. Make sure to pin the current version and update it only after checking for API changes.