Install the CLI (Coming Soon)
Set up the AskUI CLI to run Projects headless, in CI, or across many devices.
The AskUI CLI (askui) runs the same Projects you author in AskUI Desktop,
without the UI. One command, askui run, executes your tests against a
desktop, a browser, or an Android device and writes the same reports the app
produces. Use it locally for scripted runs, in CI, or on a schedule.
Install the CLI (coming soon)
The CLI is not yet publicly available, the installer is in progress. This page documents what running it looks like so you can plan your CI setup; the steps below apply once the CLI ships.
Verify the install
askui --helpYou should see the askui run usage with its options.
Set up the surface you want to drive
Desktop runs need AgentOS on the machine under test. On
your own machine, the CLI starts a local AgentOS automatically for the
run; if AgentOS is installed as a service,
the CLI detects and attaches to it instead. For a remote machine, install
AgentOS there and point the CLI at it with --controller-host.
Nothing to install up front: on the first --surface web run, the CLI
downloads the browser it drives (Chromium via Playwright) automatically.
adb must be on your PATH and the device (or emulator) visible to
adb devices. See the ADB setup guide.
Authenticate
With the default model provider (the AskUI hub), the CLI reads two environment variables:
export ASKUI_WORKSPACE_ID="<your workspace id>"
export ASKUI_TOKEN="<your access token>"Create the access token in the AskUI Hub, see
Workspaces & access tokens. Instead of
exporting, you can also put both lines in a .env file in your Project root;
the CLI loads it on every run (variables already set in the environment win).
Run a Project
cd my-project
askui runSee Running from the CLI for the full command reference, plans, surfaces, model selection, and CI usage.