helpparameter, CLI will display self-explanatory usage instructions, e.g.
--versionoption will print the TestProject Agent CLI version, e.g.
--forkoption CLI process can be forked when the Agent process is started. In this mode, no STD will be attached and CLI will not wait for the Agent to exit. This might be useful in CI / CD pipelines and various configurations.
2.2.0, to allow external connectivity for the CLI or the SDK incoming requests, additional parameters should be used:
--grpc-address, Agent can be instructed for binding its gRPC to other host and port.
--rest-address, Agent can be instructed for binding its Web Server to other hosts and port.
10.0.0.2:65000, and SDK can communicate with the Agent using any of the available hosts and port
--max-workersoption, it is possible to set the maximum amount of workers for an Agent. Workers amount is the number of tasks an Agent can perform in parallel.
If there is no Agent running, a relevant error message will appear.
Agent must be running before a registration attempt. It can be started using the start command if necessary.
--tokenrequired options that should be used to invoke the command properly. For example right after installation, you can run the following command to register the Agent as MyAgent:
If the Agent is already registered, a relevant error message will appear.
listparameter specified, CLI will list devices:
--iosoptions, list can be filtered by a mobile platform.
--virtualoptions, either physical or virtual devices only can be requested.
--json, that will output results as JSON, for example:
appsparameter specified, CLI will list apps installed on a device. It requires an additional argument
--deviceto be specified, for example:
--jsonoption same output will be presented as a JSON:
Protocol version indicates what is the TestProject Agent CLI compatible version for this backup file.
--jsonthe option is used:
--settingsshould be used to provide an external setting file.
--deviceto provide a list of target browsers or devices as command arguments.
Since no setting are bundled, and none are provided, default target will be used. Chrome or any other installed browser for Web test and any connected device for Mobile.
settings.yamlinstead of the settings inside the archive. The same could be achieved using the
--parametersoption should be used:
--agentparameter that is used to specify a remote Agent. Using this URL, a report that is generated by the remote Agent can be retrieved from the remote machine.
--output-pathparameter can be used:
MyFirstTestBackup.zipbundle and generate a report in
~/Desktop, for example:
Specifying a custom report file location will result in no report URL link appearing in logs.
--plainoption to output plain text progress.
Progress does not indicate steps results such as passed or failed, but only a periodic indication of the execution advancement. Therefore, when using the
--plainoption, the same step might appear more than once or do not appear at all if execution advances too quickly.
--parallel-testsoptions, package execution can be parallelized. By default the execution is serial, meaning that tests will be executed one by one on each defined browser/device.
--parallel-targetswill result in tests being executed one by one on all defined browsers/devices, in parallel.
--parallel-testswill result in all tests being executed on all defined browsers simultaneously. If a test has a data source, all data iterations will run at the same time as well.
These options override any similar settings set via the package's bundle settings YAML file.
2.2.0, there are several global options that can be used with all the commands that interact with an Agent. For example,
--agentoption, allows targeting a remote Agent, in the same network, on a different machine:
10.0.0.2:9999. The accepted format for the target Agent address is
Running packages on a remote Agent, is currently not supported.
--connect-timeoutoption, specified in seconds, as shown below: