Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

UI-licious Command Line Interface


UI-licious is a tool for development teams to rapidly create and run end-to-end user journey tests for their web applications.

This command line interface allows you to run and manage your UI-licious tests through the command line.

Note that the UI-licious CLI can only be used with an active subscription of UI-licious.


You may install the CLI by downloading the recommended binary distribution, or via NPM.

Download binaries directly from our github release page (recommended)

Download via npm

Before installing this package, ensure that npm is updated to the latest version:

$ npm install npm@latest -g

Run the following to install uilicious-cli globally:

$ npm install uilicious-cli -g

Using --help

Use the --help option to list the available top level commands:

$ uilicious-cli --help

To get more information about a single command, use --help after the command:

$ uilicious-cli <command> --help

Run Help


You can use your access key or username and password to authenticate yourself.

Authentication with access key

Where can I get my access key?

Login to UI-licious Studio, go to "Account and Billing > Access Key" to view and regenerate your access key

You can set your access key with the --key option when using the cli, e.g.:

$ uilicious-cli run "demo" "/login/test 1" --key <acccess_key>

Alternatively, you can set the environment variable UILICIOUS_ACCESSKEY

Authentication with username and password

Alternative you can authenticate with your username and password, using the --user and --pass options e.g.

$ uilicious-cli run "demo" "/login/test 1" --user <username> --pass <password>

You can also use the short form -u or -p, e.g.:

$ uilicious-cli run "demo" "/login/test 1" -u <username> -p <password>

Running a test

Run Example

$ uilicious-cli project run  <project_name> <script_path> [--browser] [--width] [--height]
  • <project_name> - Name for the project being tested.
  • <script_path> - Name of the test script being executed.

Additional Options

  • --browser <browser_name> options : e.g. chrome, firefox, edge, safari, ie11 (default "chrome")
  • --height <browser_height> height of browser (default "960")
  • --width <browser_width> width of browser (default "1280")
  • --testCodeDir <browser_dir> Directory to use for test code, this is used instead of the existing uilicious project code.

For more additional options, please refer to the uilicious-cli project run --help output

Setting the DATA object

The DATA object is a special object you can use in the test script for dynamic test data.

You can use the DATA object in your script like this:

// Here's an example to help you get started!
I.goTo("")"Sign up")
I.see("Join GitHub")
I.fill("Username", DATA.username)
I.fill("Password", DATA.password)"Create an account")

You can set the DATA using a json string using --dataObject or by reading from json file using --dataFile.


$ uilicious-cli run "github" "Login" --dataObject {"username":"brucewayne","password":"secret","email":""}
$ uilicious-cli run "github" "Login" --dataFile "./user-brucewayne.json"


You can now configure variables for running tests on different environments.

You can manage the datasets in Uilicious Project editor. To run a test using dataset, you need to specify the name of dataset using --dataset.


uilicious-cli run Demo demo --dataset "PROD"

Upload files to a project

You can upload files from a local directory to an UI-licious project using the upload command. If the project does not exists, it will be automatically created:

uilicious-cli upload <project_name> <local_directory>

Download files from a project

You can download files from a UI-licious project to a local directory using the download command. Files will be overwritten in the destination folder if they already exist.

uilicious-cli download <project_name> <local_directory>

To test your local web applications

Plese use services such as

Native ngrok support is deprecated from v3.0.0

Deprecated Commands

Warning: Please avoid using deprecated aliases for the commands, as they may be removed in the future.

Command Deprecated aliases Removal Schedule Purpose
run none Run a test
download export none Download a project to a local directory
upload import none Upload files from a local directory to a project

Commands with removal schedule of "none" will have atleast 6 months notice warning, when we plan its removal. And will be treated as a major CLI version upgrade.

Reporting issues with the CLI / Need help ?

Find us on discord Or contact us at

Note: We do not actively monitor our github issues - as such its much more reliable to reach out to us on discord / our support email.

Copyright © 2022 Uilicious Private Limited