Connection commands#
Commands that connect the CLI to an app on AltTester® Server, and list the apps there.
Every command also takes the global options, such as --host and --port.
connect#
Connects to an AltTester®-instrumented game and starts a persistent background daemon. The daemon maintains a persistent WebSocket connection so subsequent commands execute instantly without reconnecting.
When two concurrent connect calls target the same game, only the first spawns a daemon; the second reports “Already connected”.
Parameters
Name |
Required |
Description |
|---|---|---|
|
No |
Application name to match against registered games. Acts as a case-insensitive substring filter. The default value is: |
|
No |
Platform to match (e.g. |
|
No |
Platform version to match. Acts as a case-insensitive substring filter. The default value is: |
|
No |
Application ID of the registered game. If omitted, the CLI resolves it automatically using the other filters. Pass this to disambiguate when multiple games are registered. The default value is: |
|
No |
Device instance ID for exact-match filtering. The default value is: |
|
No |
Connection timeout in seconds. The default value is: |
|
No |
Seconds of inactivity before the daemon exits automatically. The default value is: |
|
No |
Use secure WebSocket ( |
Returns
Connection status confirmation with session details.
Examples
alttester connect
alttester connect --host 192.168.1.10 --port 13000
alttester connect --timeout 10
alttester connect --idle-timeout 600
status#
Checks whether the CLI is connected to a game.
Parameters
No parameters.
Returns
Connection status (connected or disconnected) with session details.
Examples
alttester status
disconnect#
Disconnects from the game and stops the background daemon.
Parameters
Name |
Required |
Description |
|---|---|---|
|
No |
Disconnect every live session and remove every session file. The default value is: |
Returns
Confirmation.
Examples
alttester disconnect
alttester disconnect --all
apps#
Lists all games currently registered on the AltTester® server. Use this to see what games are available before connecting, or to find the right --app-id when multiple games are registered.
Parameters
Name |
Required |
Description |
|---|---|---|
|
No |
Server query timeout in seconds. The default value is: |
|
No |
Use secure WebSocket ( |
Returns
List of registered games with their name, platform, platform version, device instance ID, game engine, app ID, and status.
Examples
alttester apps
alttester apps --host 192.168.1.10