{"id":18892,"library":"uilicious-cli","title":"UI-licious CLI","description":"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.","status":"active","version":"5.1.15","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","Uilicious","CLI"],"install":[{"cmd":"npm install uilicious-cli","lang":"bash","label":"npm"},{"cmd":"yarn add uilicious-cli","lang":"bash","label":"yarn"},{"cmd":"pnpm add uilicious-cli","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"SDK for UI-licious API interactions","package":"uilicious-sdk","optional":false}],"imports":[{"note":"ESM-only package; no default export for programmatic use – CLI is primarily used via command line.","wrong":"const uilicious = require('uilicious-cli')","symbol":"default","correct":"import uilicious from 'uilicious-cli'"},{"note":"Named export for programmatic API; requires manual instantiation.","wrong":"import { Cli } from 'uilicious-cli'","symbol":"UiliciousCli","correct":"import { UiliciousCli } from 'uilicious-cli'"},{"note":"Named export for running tests programmatically; accepts options object.","wrong":"import { run } from 'uilicious-cli'","symbol":"runTest","correct":"import { runTest } from 'uilicious-cli'"}],"quickstart":{"code":"// Run a test via CLI\n// Authenticate and run a test with access key\nprocess.env.UILICIOUS_ACCESSKEY = process.env.KEY ?? '';\nconst { execSync } = require('child_process');\nconst cmd = 'uilicious-cli project run \"MyProject\" \"/login/test\" --key ' + process.env.UILICIOUS_ACCESSKEY;\nconst output = execSync(cmd, { encoding: 'utf8' });\nconsole.log(output);","lang":"javascript","description":"Shows how to run a UI-licious test via CLI with access key authentication."},"warnings":[{"fix":"Obtain a valid access key from UI-licious Studio.","message":"The CLI requires an active UI-licious subscription and will fail without valid credentials.","severity":"breaking","affected_versions":">=0.0.0"},{"fix":"Use `--key` or `UILICIOUS_ACCESSKEY` environment variable.","message":"Authorization via username/password (`--user`, `--pass`) is deprecated in favor of access key.","severity":"deprecated","affected_versions":">=5.0.0"},{"fix":"Enclose the JSON in single quotes and avoid spaces, or use `--dataFile` instead.","message":"The `--dataObject` option expects a JSON string; spaces in the JSON will break parsing.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Update Node.js to >=10 or use binary downloads from GitHub releases.","message":"Global installation via npm may fail on Node.js <10 because of engine restrictions.","severity":"gotcha","affected_versions":"<5.0.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Ensure you have an active subscription and a valid access key set via `--key` or `UILICIOUS_ACCESSKEY`.","cause":"Trying to run tests without a valid UI-licious subscription.","error":"Error: You do not have an active subscription. Please check your account."},{"fix":"Regenerate a new access key from UI-licious Studio and use `--key` or `UILICIOUS_ACCESSKEY`.","cause":"The access key provided is incorrect or expired.","error":"Error: Invalid access key"},{"fix":"Run `npm install uilicious-sdk` alongside `uilicious-cli`.","cause":"Missing dependency when trying to import the package programmatically.","error":"Error: Cannot find module 'uilicious-sdk'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}