Tests, setup and updates#
Commands that run tests, set up a test project, start AltTester® Desktop or the app, and update or remove the CLI.
Every command also takes the global options, such as --host and --port.
run-tests#
Runs Robot Framework tests with automatic environment setup and report generation.
Results are saved to a timestamped directory under results/ and include report.html and log.html. An interactive dashboard aggregating all runs is also generated at results/dashboard.html.
Parameters
Name |
Required |
Description |
|---|---|---|
file |
No |
Path to a test file or directory to run. The default value is: |
|
No |
Run only the test with this exact name. |
|
No |
Run only tests tagged with this tag. |
|
No |
Report the state of the current or latest test run instead of starting a new one. Used mainly with the AI Extension, where test runs are started in the background. |
Returns
Test results summary and path to the report directory.
Examples
alttester run-tests # Run all tests in tests/
alttester run-tests tests/login.robot # Run a specific file
alttester run-tests --test "Test Login Flow" # Run a specific test by name
alttester run-tests --include smoke # Run tests tagged 'smoke'
run-keyword#
Executes a single Robot Framework keyword from your test library.
Keywords are loaded from .resource files in tests/actions/, tests/checks/, and tests/flows/.
Parameters
Name |
Required |
Description |
|---|---|---|
keyword |
No |
The keyword name to execute. Omit when using |
|
No |
Arguments to pass to the keyword. |
|
No |
If set, lists all available keywords instead of running one. |
Returns
The keyword execution result, or a list of available keywords when using
--list.
Robot output files are written to <working_dir>/.alttester-cli/keyword-results/.
Examples
alttester run-keyword --list # List available keywords
alttester run-keyword "Click Play Button" # Run a keyword
alttester run-keyword "Set Player Name" --args "Player1"
setup-project#
Creates a new test automation project from a starter template.
Parameters
Name |
Required |
Description |
|---|---|---|
language |
Yes |
The language for the starter project. Supported values: |
|
No |
Name of the game being tested. The default value is: |
|
No |
Directory where the project will be created. The default value is the current directory. |
|
No |
A brief description of the game, used in generated documentation. |
Returns
Confirmation and the path to the created project directory.
Examples
alttester setup-project python
alttester setup-project dotnet --name "MyGame" --description "Platform adventure game"
docs#
Accesses built-in AltTester® documentation.
At least one of --list, --read, or --search must be provided. Running alttester docs without any option prints usage instructions.
Parameters
Name |
Required |
Description |
|---|---|---|
|
Yes (if |
List all available documents. |
|
No |
Name of the document to read. |
|
No |
Search term to look for across all documents. |
Returns
List of document names (
--list), document content (--read), or matching excerpts (--search).
The available documents include the general AltTester® docs plus Robot Framework skill guides, which are namespaced as robot/<topic> (e.g. alttester docs --read robot/authoring).
Examples
alttester docs --list
alttester docs --read overview
alttester docs --search "locator"
start-desktop#
Launches the AltTester® Desktop application.
Parameters
No parameters.
Returns
Confirmation.
Examples
alttester start-desktop
start-game#
Launches a game executable.
Parameters
Name |
Required |
Description |
|---|---|---|
path |
Yes |
Full path to the game executable. |
Returns
Confirmation.
Examples
alttester start-game /path/to/MyGame.app
uninstall#
Removes the AltTester® CLI binary from your system.
Parameters
Name |
Required |
Description |
|---|---|---|
|
No |
Skip the confirmation prompt. Required in non-interactive terminals such as Git Bash. |
|
No |
Also remove the |
Returns
Confirmation that the CLI has been removed.
Examples
alttester uninstall
alttester uninstall --yes
alttester uninstall --yes --purge
update#
Updates the CLI to the latest version.
The CLI also checks for updates automatically (see Updating the CLI below), so you usually don’t need to run this manually.
Parameters
Name |
Required |
Description |
|---|---|---|
|
No |
Check whether a newer version is available without downloading or installing it. |
|
No |
Enable or disable automatic updates on startup. Accepts |
Returns
The current and latest versions, and confirmation when an update is installed.
Examples
alttester update # Update to the latest version
alttester update --check # Check for a new version only
alttester update --auto-update off # Disable automatic updates
alttester update --auto-update on # Re-enable automatic updates