Quickstart

Get AskUI running in 5 minutes.

1. Sign Up

Create account at hub.askui.com. You’ll get:

• Workspace ID
• Access Token

2. Install Agent OS

Windows

Windows AMD64

Intel/AMD

Windows ARM64

ARM

# Or via CLI
Invoke-WebRequest -Uri "https://files.askui.com/releases/Installer/25.11.1/AskUI-Suite-25.11.1-User-Installer-Win-AMD64-Web.exe" -OutFile "AskUI-Setup.exe"
.\AskUI-Setup.exe

macOS

macOS ARM64

Apple Silicon (M1/M2/M3/M4)

curl -o AskUI-Setup.run https://files.askui.com/releases/Installer/25.11.1/AskUI-Suite-25.11.1-User-Installer-MacOS-ARM64-Web.run
chmod +x AskUI-Setup.run && ./AskUI-Setup.run

Apple Silicon only. Intel Macs not supported.

Linux

Linux AMD64

Intel/AMD

Linux ARM64

ARM

curl -o AskUI-Setup.run https://files.askui.com/releases/Installer/25.11.1/AskUI-Suite-25.11.1-User-Installer-Linux-AMD64-Web.run
chmod +x AskUI-Setup.run && ./AskUI-Setup.run

X11 only. Wayland not supported.

3. Install SDK

pip install askui

Set credentials:

macOS/Linux

export ASKUI_WORKSPACE_ID="your-workspace-id"
export ASKUI_TOKEN="your-access-token"

Windows PowerShell

$env:ASKUI_WORKSPACE_ID="your-workspace-id"
$env:ASKUI_TOKEN="your-access-token"

4. Run First Task

# first_task.py
from askui import VisionAgent

with VisionAgent() as agent:
    agent.act("""
        Open a web browser
        Navigate to google.com
        Type "AskUI automation" in search box
        Press Enter
    """)

python first_task.py

Demo Project

git clone https://github.com/Lumpin-askui/AskUI-Demo-Project.git
cd AskUI-Demo-Project
pip install -r requirements.txt
python act.py

CSV-based test automation with screenshots and reports.