Getting Started


Unravel requires Node.js (at least version 8) and Google Chrome (at least version 60) to be installed locally.

Chrome installation instructions can be found here:

Node.js installation instructions can be found here:

The Unravel Command Line Interface is installed from NPM:

npm i -g @unravel/unravel-cli
Installing the Unravel CLI from NPM

Running a test

This is an example Unravel test:

# Test a Login form can be used succesfully

  definition: |
    load url
    set "tomsmith" for "username"
    set "SuperSecretPassword!" for "password"
    click "login"
    assert "you logged into a secure area"

You can download this file here.

This example test loads a login page, fills the form fields with correct credentials, and asserts that the login form behaves correctly.

To run the test, first we have to get an Unravel API key. You can get an Unravel API key by signing up here.

If you already have an account, you get get your key here:

You can provide the Unravel API key as an environmental variable, or pass it as an argument with the --key flag:

Now we can run the test with the unravel command:

$ unravel --key $YOUR_API_KEY login-success.yaml
Unravel test running in the console

Unravel will now launch a local Chrome instance (with a fresh profile so it won't affect your own Chrome settings), and run the test:

Congratulations - you've just run your first Unravel test!