​
General:

  • ASKUI_WORKSPACE_ID: A unique identifier for your AskUI workspace.
  • ASKUI_TOKEN: An access token used for authentication with the AskUI API.

​
Proxy:

  • HTTP_PROXY: The URL for an HTTP proxy server.
  • HTTPS_PROXY: The URL for an HTTPS proxy server.
  • NO_PROXY: A list of hosts or domains that should not use a proxy.

​
Vision Agent:

  • ASKUI_INFERENCE_ENDPOINT: The URL of the Vision Agent’s inference endpoint, which handles image and text analysis.
  • ASKUI_CONTROLLER_PATH: The file path to the controller’s executable or binary file.
  • ASKUI__VA__TELEMETRY__ENABLED: A boolean flag to enable or disable the recording of usage data for the Vision Agent. Setting this variable to False will disable telemetry.
  • ASKUI_CONTROLLER_ARGS: Command-line arguments for the AskUI Remote Device Controller. See details in ASKUI_CONTROLLER_ARGS.

​
AskUI Suite:

  • ASKUI_COMPONENT_REGISTRY_FILE: The path to a file that defines custom UI components for AskUI.
  • ASKUI_INSTALLATION_DIRECTORY: The directory where the AskUI suite is installed.
  • ASKUI_DISABLE_TELEMETRY: A boolean flag to disable the recording of usage data for the AskUI suite. Setting this variable to True will disable telemetry.

​
AskUI Controller Auto Recover Service:

  • ASKUI_RUNNER_WIDTH: The width of screen to be used for the runner window, after disconnecting from RDP session.
  • ASKUI_RUNNER_HEIGHT: The height of screen to be used for the runner window, after disconnecting from RDP session.

​
Details

​
ASKUI_CONTROLLER_ARGS

Supported arguments:
  • --showOverlay [true|false]: Controls whether the controller shows an overlay on the screen during automation. Default is true.
  • --debugDraw [true|false]: Enables or disables debug drawing features for troubleshooting.
  • --configFile <AbsolutePathToConfigFile>: Specifies the path to a configuration file for the controller.
Examples: 
# Disable overlay and use custom config file
ASKUI_CONTROLLER_ARGS="--showOverlay false --configFile /path/to/config.json"

# Disable overlay only
ASKUI_CONTROLLER_ARGS="--showOverlay false"

# Enable debug drawing
ASKUI_CONTROLLER_ARGS="--debugDraw true"
Default value: --showOverlay true