Run AskUI Studio's Workflow on Your Local Windows Machine with Self-Hosted Runner

March 4, 2024
linkedin icontwitter iconfacebook iconmail icon

In this guide, we will walk you through the steps that you need for running an AskUI self-hosted runner on your local Windows machine. The AskUI self-hosted runner is a self-hosted component that downloads your workflows from AskUI Studio and runs them on the device it is hosted at. So this guide presumes that you already have an account for the AskUI Studio as well as know how to create a workflow in it. If you don't have an account yet, please first create one here for free.

Table of Content

  1. Install the Remote Device Controller
  2. Create a Workflow in the AskUI Studio
  3. Run AskUI Development Environment (ADE)
  4. Connect Your AskUI Account
  5. Run the Self-Hosted Runner
  6. Run the Workflow in the AskUI Studio

1. Install the Remote Device Controller

First, install the Remote Device Controller with the AskUI Installer.

It will install the following components:

Here is a more descriptive explanation of the installation process (link to the documentation).

2. Create a Workflow in the AskUI Studio

Now let's create a simple workflow for testing our self-hosted runner on the local Windows machine.

First create a new workflow with the name windows_test, then copy and paste the code below into the Code view:

-- CODE language-ts line-numbers -- import { aui } from "@/helper/jest.setup"; it("windows_test.ts", async () => { await aui.pressKey('command').exec(); await aui.type('wordpad').exec(); await aui.pressKey('enter').exec(); await aui.moveMouse(500,500).exec(); });

After pressing the SAVE button on the right top corner, you will have a workflow created in your Steps view:

Quickly explained, this workflow will,

  1. Press the command key, which is equivalent to the windows key.
  2. Type wordpad in the search field of the start menu.
  3. Press the enter key to open the Wordpad app.
  4. Move the mouse cursor to the coordinate 500, 500.

It is a very simple workflow that automates the process of opening the Wordpad app on your local Windows machine and move the mouse cursor to a certain coordinate, yet good enough to ensure that the AskUI self-hosted runner is properly prepared on your local machine.

3. Run AskUI Development Environment (ADE)

  1. Open a terminal. We recommend using PowerShell.
  2. Run the command askui-shell (type it and press Enter). This brings you into the AskUI Development Environment (short ADE) where you can configure your installation, start the AskUI Controller, create new AskUI-Projects and run workflows.

4. Connect Your AskUI Account

Run the following command to authenticate and connect your ADE to your AskUI account. Replace the strings with your real credentials.

-- CODE language-bash line-numbers -- AskUI-SetSettings -WorkspaceId "a1a2a3a-b1b2-c1c2-d1d2d3d4d5d6" -Token "a1a2a3a4a5a6a7a8a9a0"

Validate the settings with the following command:

-- CODE language-bash line-numbers -- AskUI-ShowSettings

5. Run the Self-Hosted Runner

To run this workflow on your local Windows machine, we will need to run two different components on the local machine.

First start the AskUI Controller with the command below:

-- CODE language-bash line-numbers -- AskUI-StartController -DisplayNum 0

This will start the AskUI Controller and will select the first display(index 0) from the left side as the target display to be automated. You can skip the DisplayNum option if you have only one display.

After running the AskUI Controller, open another PowerShell window and run the command after activating the ADE with askui-shell as same in the previous step:

-- CODE language-bash line-numbers -- AskUI-StartRunner -Tags "test_windows"

The Tags option tells the runner which Run from your AskUI Studio it shall fetch the workflow from. We will run our workflow with the exactly same tag in the next step.

6. Run the Workflow in the AskUI Studio

Now let's go back to our AskUI Studio and run the workflow.

Go to the Runs view by clicking the Runs tab on the side.

Then, click the [+ New run] and create a new run with the information below. It is important to give the exact same Tag as we did in the PowerShell in the previous step:

After creating a new run by clicking the CREATE button, the AskUI Runner will start to run the selected workflow on the local Windows machine. Here is the full video of the automation that we run:


Following the steps outlined in this guide, you have successfully set up and run an AskUI self-hosted runner on your local Windows machine. This enables you to automate tasks using workflows created in the AskUI Studio directly on your device. If you need more informations of our ADE and self-hosted runner on Windows, please check out our official documentations listed below:

And if you face issues or get more questions about AskUI, don't hesitate to contact us!

Haram Choi
March 4, 2024
On this page