Agent Command Center (ACC) is the desktop service that manages Execution Agents on the machines where the automation tests should run. This command-line interface (CLI) provides the ability to manage these services through the command line and is helpful in environments where desktop UI is not available on the Agent machines. If your Agent host supports desktop UI, you can use ACC portal.
You can download the CLI installable from the Resources tab in ACCELQ.
To install or update ACC (Agent Command Center) in your device, run the following command on the shell.
This will open in an interactive command-line mode with step-by-step instructions on the installation process.
Getting Started with ACC CLI
Here are the supported top-level commands that should give you an idea of the underlying pattern for working with the CLI.
$ acc [-hV] <command>
|start||Start ACCELQ Agent Command Center with agents and services|
|stop||Stop ACCELQ Agent Command Center with agents and services|
|restart||Restart ACCELQ Agent Command Center with agents and services|
|tail||Display and continuously update real-time log for the agent (or a named agent, if running multiple agents)|
|servicetail||Display last few lines of ACCELQ Agent Command Center service log|
|status||Display current status of the agent (or a named agent, if running multiple agents) along with ACCELQ Agent Command Center|
|add||Add a new agent with given name|
|remove||Remove an existing agent|
|workingdir||Display the agent's working folder location (or a named agent, if running multiple agents)|
|properties||Manage Agent's properties file (or a named agent, if running multiple agents). Type "--help" for more options|
|jobs||List all the jobs running on the agent (or a named agent, if running multiple agents)|
|cleanup||Reset a existing agent to its initial state, cleaning up the cache and zombied drivers if any|
|appium||Manage ACCELQ Appium Server. Type "--help" for more options|
|device||Manage mobile devices used for mobile execution. Type "--help" for more options|
|ios-settings||Manage ACCELQ iOS Configuration using an interactive cli|
|update||Check and update ACCELQ Agent Command Center|
|uninstall||Uninstall ACCELQ Agent Command Center from this device|
|help||Help about any command|
The following flags are supported:
|-h, --help||help for ACC|
|-v, --version||version for ACC|
To get detailed help,
$ acc --help
$ acc <command> --help
Manage ACCELQ Execution Agents
ACCELQ Command Center is a service that can manage one or more Execution Agents on a desktop system. When you are using commands that work against an execution agent, you may ignore the Agent name if there is only one Agent running on the system. Otherwise, you may need to supply the name of the Agent as part of the command-line argument.
Start ACCELQ Execution Agents
This command starts the Agents and Services if not already running. You can also start a specific agent by its name in case you have multiple agents installed in your system.
$ acc start
$ acc start --agent <name>
Stop ACCELQ Execution Agents
This command stops the running Agents and Services. You can also stop a specific agent by its name in case you have multiple agents installed in your system.
$ acc stop
$ acc stop --agent <name>
Restart ACCELQ Execution Agents
This command stops the Agents and service and then starts all over again. You cannot selectively restart a named agent.
$ acc restart
List all ACCELQ Execution Agents and their status
To list all the locally installed agents with their current status, use the following command
$ acc status
$ acc status --agent <name>
Add a new ACCELQ Execution Agent
To install a new ACCELQ Execution Agent, type the following with the proposed name of the new agent. The name must be unique across all the agents installed on this ACC. Also, space characters and special characters are not allowed in Agent name.
$ acc add --agent <name>
Remove an existing ACCELQ Execution Agent
To remove an existing ACCELQ Execution Agent, use the following command with the name of the agent.
Note that at least one Agent must be available on the system at any point. It is not allowed to remove the last Agent unless you uninstall the ACC.
$ acc remove --agent <name>
Reset an existing ACCELQ Execution Agent
To reset an existing ACCELQ Execution Agent to its initial state, you can use the following command. In case multiple agents are present, you need to specify the agent name to reset.
$ acc cleanup [when there is only one agent]
$ acc cleanup --agent <name>
Execution Agent Logs
To view the real-time log of the ACCELQ Execution Agents, use the following command. You can also tail a named agent as well.
$ acc tail [when there is only one agent]
$ acc tail --agent <name>
You can also view the log of the underlying ACC service, using servicetail command.
$ acc servicetail
Retrieve the ACCELQ Execution Agent Working Directory
Sometimes you may need to know the ACCELQ Execution Agent Working Directory (Agent Folder) for troubleshooting purposes. In such cases, this command comes into play.
$ acc workingdir [when there is only one agent]
$ acc workingdir --agent <name>
Configure ACCELQ Execution Agent Properties
To display the location and contents of the agent.properties file for your agent, run
$ acc properties [when there is only one agent]
$ acc properties --agent <name>
To update a specific property in the file, run
$ acc properties --agent <name> --set <property_name>=<value>
To edit your properties in bulk, with your favorite text editor, run
$ acc properties --agent <name> --edit
Note: This option is not feasible in cases where the command line is run from ssh or another similar remote option.
To replace the entire properties file with a new one, run
$ acc properties --agent <name> --file <file>
The agent flag is optional in case only one agent is present in the system.
List all ACCELQ Agent Jobs
To list all jobs along with their job ids, run
$ acc jobs
$ acc jobs --agent <name>
Manage your ACCELQ Appium Server
With ACC CLI you can manage and get information about your ACCELQ Appium Server used for mobile automation. Use one of the following commands.
$ acc appium [-h] <command>
|status||Displays current status of the appium server|
|start||Start the appium server|
|stop||Stop the appium server|
|restart||Restart the appium server|
|tail||Displays the real-time log for the appium server|
|-h, --help||help for appium|
Manage your mobile devices
With ACC CLI you can manage and get information about mobile devices used for automation runs.
$ acc device [-h] <command> [--udid <udid>]
|list||Display the list of device names, status, and OS information [includes iOS stimulators]|
|info||Display device info like name, status, os with version, etc|
|apps||List the names of installed apps in the device|
|log||Show device-specific logs (for iOS only)|
|setup||Show device setup information (for iOS only)|
|-h, --help||help for device|
|-u, --udid <uuid>||device udid parameter|
Manage iOS Devices
With ACC CLI you can manage certificates and profiles for WebDriverAgent application signing process. Use the below command
$ acc ios-settings
This opens up an interactive CLI from where you can set up and manage the iOS settings.
Check and Update ACCELQ Execution Services
To ensure up-to-date functioning and optimal performance, use the following command to check and apply any necessary updates to ACC services
$ acc update
Uninstall ACCELQ Execution Agents and Services
To uninstall all the agents along with the services, you can use the following command
$ acc uninstall