UI-licious CLI

5.1.15 verified Sat Apr 25 auth: no javascript

Uilicious CLI is a command-line tool for running and managing UI-licious end-to-end user journey tests. Version 5.1.15 supports Node.js >=10.0.0 and npm >=5.6.0. It allows authentication via access keys or username/password, and test execution with configurable browser, viewport, and dynamic data objects. The CLI is designed for teams with active UI-licious subscriptions, offering both npm and direct binary downloads. It differs from other test runners by tightly integrating with the UI-licious cloud platform.

Common errors

error Error: You do not have an active subscription. Please check your account. ↓

cause Trying to run tests without a valid UI-licious subscription.

fix

Ensure you have an active subscription and a valid access key set via --key or UILICIOUS_ACCESSKEY.

error Error: Invalid access key ↓

cause The access key provided is incorrect or expired.

fix

Regenerate a new access key from UI-licious Studio and use --key or UILICIOUS_ACCESSKEY.

error Error: Cannot find module 'uilicious-sdk' ↓

cause Missing dependency when trying to import the package programmatically.

fix

Run npm install uilicious-sdk alongside uilicious-cli.

Warnings

breaking The CLI requires an active UI-licious subscription and will fail without valid credentials. ↓

fix Obtain a valid access key from UI-licious Studio.

deprecated Authorization via username/password (`--user`, `--pass`) is deprecated in favor of access key. ↓

fix Use `--key` or `UILICIOUS_ACCESSKEY` environment variable.

gotcha The `--dataObject` option expects a JSON string; spaces in the JSON will break parsing. ↓

fix Enclose the JSON in single quotes and avoid spaces, or use `--dataFile` instead.

gotcha Global installation via npm may fail on Node.js <10 because of engine restrictions. ↓

fix Update Node.js to >=10 or use binary downloads from GitHub releases.

Install

npm install uilicious-cli

yarn add uilicious-cli

pnpm add uilicious-cli

Imports

default
wrong
```
const uilicious = require('uilicious-cli')
```
correct
```
import uilicious from 'uilicious-cli'
```
ESM-only package; no default export for programmatic use – CLI is primarily used via command line.
UiliciousCli
wrong
```
import { Cli } from 'uilicious-cli'
```
correct
```
import { UiliciousCli } from 'uilicious-cli'
```
Named export for programmatic API; requires manual instantiation.
runTest
wrong
```
import { run } from 'uilicious-cli'
```
correct
```
import { runTest } from 'uilicious-cli'
```
Named export for running tests programmatically; accepts options object.

Quickstart

Shows how to run a UI-licious test via CLI with access key authentication.

// Run a test via CLI
// Authenticate and run a test with access key
process.env.UILICIOUS_ACCESSKEY = process.env.KEY ?? '';
const { execSync } = require('child_process');
const cmd = 'uilicious-cli project run "MyProject" "/login/test" --key ' + process.env.UILICIOUS_ACCESSKEY;
const output = execSync(cmd, { encoding: 'utf8' });
console.log(output);