> ## Documentation Index
> Fetch the complete documentation index at: https://docs.askui.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AskUI Suite 25.2.1

> Release notes for AskUI Suite version 25.2.1

## General

The AskUI Suite is a comprehensive bundle that includes all necessary dependencies to deliver AskUI to end users. Additionally, it addresses enterprise challenges such as user rights restrictions and proxy issues, ensuring a seamless AskUI experience.

This release focus on:

1. Enhance On-Boarding experience for Users with the new [AskUI Hub](https://hub.askui.com/)
2. Support [Python Vision Agent](https://github.com/askui/vision-agent)
3. Improve ADE
4. Improve Proxy Handling and Autodetection

## Setup

### Suported Operating Systems

* **Windows 11**
  * Version: 22H2
  * Architectures: AMD64, ARM64
* **MacOS**
  * Version: 14.x
  * Architecture: ARM64 (Apple Silicon)
* **Linux**
  * Version: Ubuntu 22.04.2
  * Architectures: AMD64, ARM64

### Download

| OS      | Arch  | Link                                                                                                            |
| ------- | ----- | --------------------------------------------------------------------------------------------------------------- |
| Windows | AMD64 | [Link](https://files.askui.com/releases/Installer/25.2.1/AskUI-Suite-25.2.1-User-Installer-Win-AMD64-Web.exe)   |
| Windows | ARM64 | [Link](https://files.askui.com/releases/Installer/25.2.1/AskUI-Suite-25.2.1-User-Installer-Win-ARM64-Web.exe)   |
| MacOS   | ARM64 | [Link](https://files.askui.com/releases/Installer/25.2.1/AskUI-Suite-25.2.1-User-Installer-MacOS-ARM64-Web.run) |
| Linux   | AMD64 | [Link](https://files.askui.com/releases/Installer/25.2.1/AskUI-Suite-25.2.1-User-Installer-Linux-AMD64-Web.run) |
| Linux   | ARM64 | [Link](https://files.askui.com/releases/Installer/25.2.1/AskUI-Suite-25.2.1-User-Installer-Linux-ARM64-Web.run) |

### Installation

Please follow our offical [installation guide](https://docs.askui.com/introduction/02-getting-started/02-installation-guide).

## Migration from 24.12.1 to 25.2.1

1. Uninstall AskUI Suite
   * **Windows:**  Settings -> Apps -> Installed Apps ->Select AskUI Suite -> Press deinstall
   * **Mac:** Open shell -> `sh "$ASKUI_INSTALLATION_DIRECTORY/Tools/uninstall-askui-suites.sh"`
   * **Linux:** Open shell -> `sh "$ASKUI_INSTALLATION_DIRECTORY/Tools/uninstall-askui-suites.sh`
2. Continue with the [installation guide](https://docs.askui.com/introduction/02-getting-started/02-installation-guide)
3. Create new Access Token in [AskUI Hub](https://hub.askui.com/)
4. Set the access token

## Known Issues

* **PxProxy** is available only for Windows AMD64.
* **ADE Startup Time** is slower than in the previous version.
* **Windows Users** may encounter long path issues when installing and using ADE.
* **Project Support**: `AskUI-NewProject` and `AskUI-RunProject` only support TypeScript projects.

***

## Release Notes

## New Features

### ADE: Information Commandlets

<AccordionGroup>
  <Accordion title="AskUI-ShowAvailableCommands - Displays all available commands.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowAvailableCommands)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> AskUI-ShowAvailableCommands
    Public Commands:

    CommandName                             Source
    -----------                             ------
    AskUI-RemoveLocalProxySettings          Public.Local.Proxy
    AskUI-SetLocalProxySettings             Public.Local.Proxy
    AskUI-StartLocalProxy                   Public.Local.Proxy
    AskUI-StopLocalProxy                    Public.Local.Proxy
    AskUI-EnablePythonEnvironment           Public.PythonManager
    AskUI-NewPythonEnvironment              Public.PythonManager
    AskUI-RemovePythonEnvironment           Public.PythonManager
    AskUI-ShowInstalledPythonPackageVersion Public.PythonManager
    AskUI-ShowPythonEnvironments            Public.PythonManager
    AskUI-ShowControllers                   Public.UiController
    AskUI-StartController                   Public.UiController
    AskUI-StopControllers                   Public.UiController
    AskUI-EnableLongPath                    Public.WindowsTools
    AskUI-TestLongPathSupport               Public.WindowsTools
    AskUI-GetRunnerVersion                  Public.AskUIRunner
    AskUI-InstallRunner                     Public.AskUIRunner
    AskUI-OpenAgent                         Public.AskUIRunner
    AskUI-ShowAgents                        Public.AskUIRunner
    AskUI-StartRunner                       Public.AskUIRunner
    AskUI-SyncAgents                        Public.AskUIRunner
    AskUI-NewProject                        Public.Project.Manager
    AskUI-RunProject                        Public.Project.Manager
    AskUI-ImportDebugCommands               Public.ADE.UserInterface
    AskUI-ImportExperimentalCommands        Public.ADE.UserInterface
    AskUI-ShowAvailableCommands             Public.ADE.UserInterface
    AskUI-ShowVersions                      Public.ADE.UserInterface
    AskUI-TestConnection                    Public.ADE.UserInterface
    AskUI-AddPlugin                         Public.Plugin.Manager
    AskUI-RemovePlugin                      Public.Plugin.Manager
    AskUI-ShowPlugins                       Public.Plugin.Manager
    AskUI-RemoveSettings                    Public.EnvironmentManager
    AskUI-SetSettings                       Public.EnvironmentManager
    AskUI-ShowSettings                      Public.EnvironmentManager


    Info:  To load experimental commands, run 'AskUI-ImportExperimentalCommands'.
    Info:  To load debug commands, run 'AskUI-ImportDebugCommands'.
    Info:  To get detailed information about a command, run 'Get-Help <CommandName>'.
    ```
  </Accordion>

  <Accordion title="AskUI-ShowVersions - Displays all AskUI components and versions.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowVersions)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> AskUI-ShowVersions
    AskUI Suite Version: 25.2.1
    Extensions:

    Name                          Version Type
    ----                          ------- ----
    ADE                           0.9.3   Component
    NodeJS                        21.0.0  Component
    AskUIOCRTeaching              0.4.0   Component
    PowerShell                    7.4.6   Component
    PxProxy                       0.9.2   Component
    Python                        3.13.1  Component
    AskUIRemoteDeviceController   0.14.0  Component
    AskUIRemoteDeviceSnippingTool 0.2.0   Component
    UIController                  0.14.8  Component
    AskUIWindowsTools             1.0.0   Component
    AskUIRunnerManager            0.1.0   Component
    ADE.ProcessManager            0.1.0   Feature
    ADE.ProjectManager            0.1.0   Feature
    ADE.ErrorReporter             0.1.0   Feature
    ADE.UserInterface             0.1.0   Feature
    ADE.PluginManager             0.1.0   Feature
    ADE.EnvironmentManager        0.1.0   Feature


    ```
  </Accordion>
</AccordionGroup>

### ADE: Proxy Commandlets

<AccordionGroup>
  <Accordion title="Autostart of Local Proxy - Start the Local Proxy if proxy are set in the system settings when starting the askui-shell. Manual start of Local Proxy with AskUI-StartLocalProxy is not necessary anymore">
    ```bash theme={null}
    PS C:\Users\MaxMustermann>  askui-shell
    Starting AskUI Development Environment (ADE) ...
    ************************************************************
       █████╗ ███████╗██╗  ██╗██╗   ██╗██╗
      ██╔══██╗██╔════╝██║ ██╔╝██║   ██║██║
      ███████║███████╗█████╔╝ ██║   ██║██║
      ██╔══██║╚════██║██╔═██╗ ██║   ██║██║
      ██║  ██║███████║██║  ██╗╚██████╔╝██║
      ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═╝
      Copyright (C) askui GmbH. All rights Reserved.
    ************************************************************
    Info:  Starting local proxy automatically ...
    Info:  Starting PX proxy ...
    ```
  </Accordion>

  <Accordion title="AskUI-TestConnection - Test if an Internet Connection is available. Mostly used in an Enterprise Environment with Proxy.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-TestConnection)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> AskUI-TestConnection
    Info:  Testing the connection to the URL: https://inference.askui.com/health
    Info:  Following proxy variables are used:
    Info:    HTTP_PROXY=
    Info:    HTTPS_PROXY=
    Info:    NO_PROXY=
    Info:  The connection to the URL 'https://inference.askui.com/health' was successful.
    Info:  Response status code: 200
    Info:  Response description: OK
    ```
  </Accordion>
</AccordionGroup>

### ADE: Windows Tools: Long Path Tools

On Windows, the maximum file path length is 260 characters. Exceeding this limit results in a "Destination Path Too Long" error. This tool helps users check and enable Windows Long Path support. This helps to avoid errors with Python Vision Agent.

<AccordionGroup>
  <Accordion title="Startup Check Warns Long Path Support is not enabled - Displays a Long Path not enabled warning when starting the askui-shell">
    ```bash theme={null}
    PS C:\Users\MaxMustermann>  askui-shell
    Starting AskUI Development Environment (ADE) ...
    ************************************************************
       █████╗ ███████╗██╗  ██╗██╗   ██╗██╗
      ██╔══██╗██╔════╝██║ ██╔╝██║   ██║██║
      ███████║███████╗█████╔╝ ██║   ██║██║
      ██╔══██║╚════██║██╔═██╗ ██║   ██║██║
      ██║  ██║███████║██║  ██╗╚██████╔╝██║
      ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═╝
      Copyright (C) askui GmbH. All rights Reserved.
    ************************************************************
    Warning:  Long Path Support is not enabled. You may encounter issues with long paths, especially when using Python.
    Info:  To enable Long Path Support, run the 'AskUI-EnableLongPath' commandlet in an elevated PowerShell session.
    Info:  To check if Long Path Support is enabled, run the 'AskUI-TestLongPathSupport' commandlet.
    ```
  </Accordion>

  <Accordion title="AskUI-TestLongPathSupport - Check if the LongPath of file systems is enabled. If not this can result in some issues with Python.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIWindowsTools/Public/AskUI-TestLongPathSupport) | [LongPath](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>  AskUI-TestLongPathSupport
    Info:  Long Path Support is enabled.
    ```
  </Accordion>

  <Accordion title="AskUI-EnableLongPath - Enables the LongPath of file systems. If not this can result in some issues with Python. Note: Needs Administrator Rights">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIWindowsTools/Public/AskUI-TestLongPathSupport) | [LongPath](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>   AskUI-EnableLongPath
    ```
  </Accordion>
</AccordionGroup>

### ADE: Plugin Manager

The ADE plugin lets you easily add or remove custom plugins in ADE, making it useful for accessing Windows features.

<AccordionGroup>
  <Accordion title="AskUI-AddPlugin - Adds an ADE plugin to the current session.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-AddPlugin)

    1. Create your test plugin for `HelloWorldCmdlet.psm1`:

    ```powershell theme={null}
    function Say-Hello {
        [CmdletBinding()]
        param (
            [string]$Name = "World"
        )

        process {
            Write-Output "Hello, \$Name!"
        }
    }

    # Export the function to be available as a cmdlet
    Export-ModuleMember -Function Say-Hello
    ```

    8. Register the plugin in the ADE

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> AskUI-AddPlugin -PluginVersion "1.0.0" -PluginName "MyPlugin" -AbsolutePluginFileNames "C:\Users\MaxMustermann\HelloWorldCmdlet.psm1"
    WARNING: The names of some imported commands from the module 'HelloWorldCmdlet' include unapproved verbs that might make them less discoverable. To find the commands with unapproved verbs, run the Import-Module command again with the Verbose parameter. For a list of approved verbs, type Get-Verb.
    ```

    9. Use your commandlet in the ADE:

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> Say-Hello
    Hello, World!
    ```
  </Accordion>

  <Accordion title="AskUI-ShowPlugins - Displays all ADE plugins to the current session.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowPlugins)

    ```bash theme={null}
    (base) ADE C:\Users\DominikKlotz> AskUI-ShowPlugins
    AskUI Suite Version: 25.2.1
    Extensions:

    Name     Version Type
    ----     ------- ----
    MyPlugin 1.0.0   Plugin
    ```
  </Accordion>

  <Accordion title="AskUI-RemovePlugin - Removes an AskUI plugin from the current session.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-RemovePlugin)

    ```bash theme={null}
    (base) ADE C:\Users\DominikKlotz>  AskUI-RemovePlugin -PluginName MyPlugin
    Info:  Plugin with name 'MyPlugin' has been removed.
    ```
  </Accordion>
</AccordionGroup>

### ADE: Python Environment Manager

The Python Environment Manager helps manage virtual environments, dependencies, and package installations, ensuring consistency across projects. It prevents conflicts and allows seamless switching between different Python versions and environments. It is used in combination with AskUI Agents from the [AskUI Hub](https://hub.askui.com/) and the [Python Vision Agent Libarary](https://github.com/askui/vision-agent)

<AccordionGroup>
  <Accordion title="AskUI-EnablePythonEnvironment - Activates a Python virtual environment.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-EnablePythonEnvironment)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>   Enable-AskUIPythonEnvironment -Name base
    (base) ADE C:\Users\MaxMustermann>
    ```
  </Accordion>

  <Accordion title="AskUI-NewPythonEnvironment - Creates a new Python virtual environment.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-NewPythonEnvironment)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>   New-AskUIPythonEnvironment -Name my-vision-agent
    (base) ADE C:\Users\MaxMustermann>
    ```
  </Accordion>

  <Accordion title="AskUI-RemovePythonEnvironment - Removes an existing Python virtual environment.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-RemovePythonEnvironment)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>   Remove-AskUIPythonEnvironment -Name my-vision-agent
    (base) ADE C:\Users\MaxMustermann>
    ```
  </Accordion>

  <Accordion title="AskUI-ShowInstalledPythonPackageVersion - Displays the installed version of a specified Python package.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-ShowInstalledPythonPackageVersion)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>AskUI-ShowInstalledPythonPackageVersion -PackageName askui
    The version of the package 'askui' is '0.2.4'.
    ```
  </Accordion>

  <Accordion title="AskUI-ShowPythonEnvironments - Lists all available Python environments.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-ShowPythonEnvironments)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>AskUI-ShowPythonEnvironments

    Name AbsoluteDirectoryName
    ---- ---------------------
    base C:\Users\DominikKlotz\.askui\.envs\base
    ```
  </Accordion>
</AccordionGroup>

### ADE: AskUI Agents and Runner Management

AskUI Agents and Runner Management enable seamless UI automation, working with the [AskUI Hub](https://hub.askui.com) for centralized control. Runners handle execution, while Agents manage interactions, ensuring smooth and scalable automation.

<AccordionGroup>
  <Accordion title="AskUI-GetRunnerVersion - Retrieves the installed version of the AskUI Runner.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-GetRunnerVersion)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> Get-AskUIRunnerVersion
    The version of the AskUI Runner is '0.2.10'.
    ```
  </Accordion>

  <Accordion title="AskUI-InstallRunner - Installs the AskUI Runner on the system.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-InstallRunner)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> AskUI-InstallRunner
    Info:  The AskUI Runner with the version '0.2.10' is already installed.
    ```
  </Accordion>

  <Accordion title="AskUI-OpenAgent - Opens the AskUI Agent in VSCode or Editor.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-OpenAgent)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann> Open-AskUIAgent
    Opening the selected AskUI Agent directory in Visual Studio Code.
    ```
  </Accordion>

  <Accordion title="AskUI-ShowAgents - Displays all available AskUI Agents on your machine.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-ShowAgents)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>  AskUI-ShowAgents
    The following Agents are available:
    WorkspaceID: 'c79299d0-6cbc-465d-bca9-9cad920e5c6d'
       Agent ID: '19ceb9ee-23f0-40a1-904e-f4a3b43346ee'
       Agent Location: 'C:\Users\MaxMustermann\.askui\Workspaces\c79299d0-6cbc-465d-bca9-9cad920e5c6d\Agents\19ceb9ee-23f0-40a1-904e-f4a3b43346ee'
    ```
  </Accordion>

  <Accordion title="AskUI-SyncAgents - Synchronizes all AskUI Agents.">
    [docs](https://askui.mintlify.app/02-api-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-SyncAgents)

    ```bash theme={null}
    (base) ADE C:\Users\MaxMustermann>  Sync-AskUIAgents -Direction Down -Delete
    2025-03-20 00:37:38,130 - INFO - Skip 19ceb9ee-23f0-40a1-904e-f4a3b43346ee/.vscode/settings.json (no changes)
    2025-03-20 00:37:38,130 - INFO - Skip 19ceb9ee-23f0-40a1-904e-f4a3b43346ee/README.md (no changes)
    2025-03-20 00:37:38,131 - INFO - Skip 19ceb9ee-23f0-40a1-904e-f4a3b43346ee/agent.yml (no changes)
    ...
    (base) ADE C:\Users\MaxMustermann>
    ```
  </Accordion>
</AccordionGroup>

## Components

### Python

We added Python 3.13.1 in our Suite.

### AskUIRemoteDeviceController 0.14.0

* Add experimental Version of Background Automation. This allows under windows to start you're automation in a child session.

## Improvments

### Installer & ADE Support Proxy Environment on Windows AMD64

* Migrated to Web Installer
  * Improved installation time to 5 min.  (Depends on internet connection)
* Auto Proxy Detection from the System Configurations
  * Support Autoconfigration with PAC files
  * Support static proxy servers

## Fixes

### AskUIRemoteDeviceController 0.14.0

* Fix segmentation bug when screen resolution changed
* Linux aui.type("///") types 777 instead
* Scroll not working
* Controller mouse event command with a count of 0 events takes too long
* Triggering single mouse events fails

### NodeJS

We updated to NodeJS 21.0.0 .

***

## **Versions**

| Name                          | Version | Release Notes                                                        |
| ----------------------------- | ------- | -------------------------------------------------------------------- |
| ADE                           | 0.9.3   |                                                                      |
| NodeJS                        | 21.0.0  | [Link](https://github.com/nodejs/node/releases/tag/v21.0.0)          |
| AskUIOCRTeaching              | 0.4.0   |                                                                      |
| PowerShell                    | 7.4.6   | [Link](https://github.com/PowerShell/PowerShell/releases/tag/v7.4.6) |
| Python                        | 3.13.1  | [Link](https://www.python.org/downloads/release/python-3131/)        |
| AskUIRemoteDeviceController   | 0.14.0  |                                                                      |
| AskUIRemoteDeviceSnippingTool | 0.2.0   |                                                                      |
| UIController                  | 0.14.8  |                                                                      |
| AskUIRunnerManager            | 0.1.0   |                                                                      |
| ADE.ProcessManager            | 0.1.0   |                                                                      |
| ADE.ProjectManager            | 0.1.0   |                                                                      |
| ADE.ErrorReporter             | 0.1.0   |                                                                      |
| ADE.UserInterface             | 0.1.0   |                                                                      |
| ADE.PluginManager             | 0.1.0   |                                                                      |
| ADE.EnvironmentManager        | 0.1.0   |                                                                      |