Skip to main content

​
System Requirements

Check the System Requirements Reference for detailed compatibility information.

​
Network Requirements

Review the Network Requirements Reference for connectivity information.

​
Installation Steps

1

Create an AskUI Account

Sign up at hub.askui.com to:
  • Activate your free trial (no credit card required)
  • Get your workspace ID and access token
  • Access documentation and support
2

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.
3

Install Python Package

Install the AskUI Python package:
pip install askui
4

Set Up Authentication

Configure your environment variables with your credentials:
  • macOS/Linux
  • Windows PowerShell
  • Windows CMD
# 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>
Get your workspace ID and token from hub.askui.com
5

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!

​
Uninstallation

If you no longer need AsKUI Suite, you can uninstall it easily. The uninstallation process will:
  • Remove all files in the AsKUI Suite installation directory.
  • Clean up environment variables such as ASKUI_INSTALLATION_DIRECTORY.
  • Delete the .askui folder from your home directory.
  • Windows
  • MacOS and Linux
Uninstall AsKUI Suite using the standard Windows uninstall process:
  1. Open the Control Panel
  2. Go to Programs → Programs and Features
  3. Find AsKUI Suite in the list of installed applications
  4. Select it and click Uninstall
  5. Follow the prompts to complete the process
After uninstallation, AsKUI Suite will be completely removed from your system.

​
Troubleshooting

  • Temporarily disable antivirus software
  • Check Windows version compatibility
  • Make sure you’re using XOrg, not Wayland
  • Check display permissions: xhost +local:
  • Verify X11 forwarding if using SSH
  • 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!
⌘I