Installation

System Requirements

Check the System Requirements Reference for detailed compatibility information.

Network Requirements

Review the Network Requirements Reference for connectivity information.

Installation Steps

Create an AskUI Account

Activate your free trial (no credit card required)
Get your workspace ID and access token
Access documentation and support

Install AskUI Agent OS

Download and install the AskUI Agent OS for your operating system:

Windows
macOS
Linux

Download the appropriate installer:

Run the installer and follow the on-screen instructions.

curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run \
  https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run
bash /tmp/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run

Agent OS currently does not work on Wayland. Switch to XOrg to use it.

For AMD64 systems:

curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run \
  https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run
bash /tmp/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run

For ARM64 systems:

curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run \
  https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run
bash /tmp/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run

Install Python Package

Install the AskUI Python package:

pip install askui[android,web]

Set Up Authentication

Configure your environment variables with your credentials (Create Access Token):

macOS/Linux
Windows PowerShell
Windows CMD
AskUI Shell
.env

# For AskUI authentication
export ASKUI_WORKSPACE_ID=<your-workspace-id>
export ASKUI_TOKEN=<your-access-token>

# For Anthropic models (optional)
export ANTHROPIC_API_KEY=<your-anthropic-api-key>

# For AskUI authentication
$env:ASKUI_WORKSPACE_ID="<your-workspace-id>"
$env:ASKUI_TOKEN="<your-access-token>"

# For Anthropic models (optional)
$env:ANTHROPIC_API_KEY="<your-anthropic-api-key>"

# For AskUI authentication
set ASKUI_WORKSPACE_ID=<your-workspace-id>
set ASKUI_TOKEN=<your-access-token>

# For Anthropic models (optional)
set ANTHROPIC_API_KEY=<your-anthropic-api-key>

AskUI-SetSettings -WorkspaceId <your-workspace-id> -Token <your-access-token>

ASKUI_WORKSPACE_ID=<your-workspace-id>
ASKUI_TOKEN=<your-access-token>

Get your Workspace Id and token from AskUI Hub

Verify Installation

Test your setup with a simple script:

from askui import VisionAgent

with VisionAgent() as agent:
    print("AskUI is installed and configured correctly!")

If you see the success message, you’re ready to build your first agent!

Troubleshooting

Installation fails on Windows

Temporarily disable antivirus software
Check Windows version compatibility

Agent OS doesn't work on Linux

Make sure you’re using XOrg, not Wayland
Check display permissions: xhost +local:
Verify X11 forwarding if using SSH

Authentication errors

Verify environment variables are set correctly
Check workspace ID and token from hub.askui.com
Ensure no extra spaces in credentials

Next Steps

Now that you have AskUI installed, proceed to Your First Agent to create your first automation!

Documentation

Tutorial

How-to Guides

Understanding AskUI

Additional Resources

System Requirements

Network Requirements

Installation Steps

Troubleshooting

Next Steps

​System Requirements

​Network Requirements

​Installation Steps

​Troubleshooting

​Next Steps

System Requirements

Network Requirements

Installation Steps

Troubleshooting

Next Steps