Experience Agent CLI

Atlas is developed as a console/CLI based application. While the primary run command runs the agent, there also utility commands for managing Experience Agent configuration.

This document provides usage instructions for the Atlas Experience Agent.

Commands

config

The config command configures the Experience Agent for use with an Experience Manager at the specified --host.

Multiple Experience Managers are supported, after config has run, the newly configured environment will be selected. To switch environments, see use below.

Param	Description
--alias	A slugified name for the Node, typically <group>-<node>-<id> (i.e. gallery-node-01). This may be changed in the Experience Manager post registration.
--host	The hostname of the Experience Manager, without a trailing slash (i.e. https://www.example.com).

keys

The keys command will confirm if you have an id_rsa and id_rsa.pub key in your user ~/.ssh directory and if it doesn't, it will prompt you to generate the keys in the appropriate location.

passwd

The passwd command will prompt you to change the Node’s password.

WARNING

This DOES NOT change the password within the Experience Manager. To change a Node password, first change it within the Experience Manager admin and then use passwd to update it on the Node.

TIP

This command is interactive and will prompt you for the appropriate input.

rehost

The rehost command changes the host that an Experience Manager is connected to. This is useful if the hostname changes, but the existing Node registration/records DO NOT.

TIP

This command is interactive and will prompt you for the appropriate input.

run

The run command runs the Experience Agent.

Param	Description
--headless	Runs the Experience Agent without the UI (reserved for future use).
--offline	Runs the Experience Agent with cached content and does not attempt to connect to the Experience Manager.

use

The use command switches between environments when multiple environments are in use. This command may be user with arguments, or interactively.

Param	Description
--config	The ID of the configuration to switch to, which is the --hostname as a reverse namespace, with . replaced with _. For https://www.example.com, the ID is com_example_www.