Skip to main content
Version: 0.4.0

Installing askui





Some users have reported instability running automation on macOS with external displays and/or virtual desktops (called Spaces). If you experience similar issues, please disconnect external displays and close virtual desktops, or see documentation on running automation in Docker.


Open a directory where you would like to place the automation. If you haven’t already, set up an NPM project by running:

npm init -y

This will create a package.json file inside your present working directory which contains the configuration of your project including a description of its dependencies.

Install askui and other dependencies for writing and executing tests:

npm i -D askui typescript ts-node @types/jest ts-jest jest
Quick explanation of all the dependencies
  • askui: Controlling a multitude of operating systems with commands based on automatically detected screen elements, colors etc.
  • typescript: Allowing you to write your tests in TypeScript instead of JavaScript
  • ts-node: TypeScript execution and REPL for node.js, with source map and native ESM support.
  • jest: Allowing you to write and run tests (describe, it, assertions, mocking etc.)
  • ts-jest: A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript
  • @types/jest: Types for Jest

Access Token

Currently, you can use our lib without any configuration. In the future, as we need to prevent misuse of our API, we may need you to create some credentials through our askui user portal (while still free) and configure our library to use these credentials for authenticating and authorizing with our API.

Please see our documentation on how to signup and create the credentials.