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

# Installation

> Install AskUI and set up your development environment

## System Requirements

Check the [System Requirements Reference](/04-reference/system-requirements) for detailed compatibility information.

## Network Requirements

Review the [Network Requirements Reference](/04-reference/network-requirements) for connectivity information.

## Installation Steps

<Steps>
  <Step title="Create an AskUI Account">
    Sign up at [AskUI Hub](https://hub.askui.com) to:

    * Activate your **free trial** (no credit card required)
    * Get your workspace ID and access token
    * Access documentation and support
  </Step>

  <Step title="Install AskUI Agent OS">
    Download and install the AskUI Agent OS for your operating system:

    <Tabs>
      <Tab title="Windows">
        Download the appropriate installer:

        * [AskUI Suite for AMD64](https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Win-AMD64-Web.exe)
        * [AskUI Suite for ARM64](https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Win-ARM64-Web.exe)

        Run the installer and follow the on-screen instructions.
      </Tab>

      <Tab title="macOS">
        ```bash theme={null}
        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
        ```
      </Tab>

      <Tab title="Linux">
        <Warning>
          Agent OS currently does not work on Wayland. Switch to XOrg to use it.
        </Warning>

        For AMD64 systems:

        ```bash theme={null}
        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:

        ```bash theme={null}
        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
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Install Python Package">
    Install the AskUI Python package:

    ```bash theme={null}
    pip install askui[android,web]
    ```
  </Step>

  <Step title="Set Up Authentication">
    Configure your environment variables with your credentials ([Create Access Token](https://hub.askui.com/)):

    <Tabs>
      <Tab title="macOS/Linux">
        ```bash theme={null}
        # 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>
        ```
      </Tab>

      <Tab title="Windows PowerShell">
        ```powershell theme={null}
        # 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>"
        ```
      </Tab>

      <Tab title="Windows CMD">
        ```cmd theme={null}
        # 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>
        ```
      </Tab>

      <Tab title="AskUI Shell">
        ```powershell theme={null}
        AskUI-SetSettings -WorkspaceId <your-workspace-id> -Token <your-access-token>
        ```
      </Tab>

      <Tab title=".env">
        ```text theme={null}
        ASKUI_WORKSPACE_ID=<your-workspace-id>
        ASKUI_TOKEN=<your-access-token>
        ```
      </Tab>
    </Tabs>

    <Tip>
      Get your Workspace Id and token from [AskUI Hub](https://hub.askui.com)
    </Tip>
  </Step>

  <Step title="Verify Installation">
    Test your setup with a simple script:

    ```python theme={null}
    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!
  </Step>
</Steps>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Installation fails on Windows">
    * Temporarily disable antivirus software
    * Check Windows version compatibility
  </Accordion>

  <Accordion title="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
  </Accordion>

  <Accordion title="Authentication errors">
    * Verify environment variables are set correctly
    * Check workspace ID and token from hub.askui.com
    * Ensure no extra spaces in credentials
  </Accordion>
</AccordionGroup>

## Next Steps

Now that you have AskUI installed, proceed to [Your First Agent](/01-tutorials/01-quickstart) to create your first automation!