Quick Start

    The BrowserUp Command Line Interface (CLI) is how we:

    • Create test configs (browserup.load.yaml)
    • Launch (deploy) the test cluster in local docker, or Amazon AWS
    • Start and Stop tests, and more

    Once the test cluster is running, we view results, create reports, administer users, etc. in the web UI.

    Let’s get started!

    Prerequisites

    The CLI is installed via NPM.

    If Javascript is not your thing, don’t worry, you don’t need to know Javascript! NPM is just how we install the CLI.

    Requirements:

    Local Cluster:

    • Docker Installed and Running (make sure it is current)
    • 32 GB Ram or more Recommended

    Cloud Cluster:

    • Amazon AWS account
    • Windows, Mac or Linux to operate the BrowserUp Command line Util
    • Local Docker is not required for remote AWS execution, so CI/CD setup can remain simple

    Installation

    npm install -g browserup

    Creating your first test

    1. Generate a basic test scaffold:
    mkdir demo
cd demo

    To see the list of test types with pre-canned examples, let’s call init with -h, for help:

    browserup load init -h

    Let’s make a test with JS and Playwright and also PostMan:

    browserup load init --playwright-js --postman

    You should see the test files in your working directory as well as a browserup.load.yaml. The browserup.load.yaml is your test config–it defines what will be run for this test. Run cat browserup.load.yaml to see what’s in it.

    1. Run your test!
    browserup load start -d

    The start command, when passed -d will run the deploy command if your cluster is not already running. This will take a couple minutes to start, and launch your test.

    When the start command finishes, you are running a test and collecting live stats!

    Let’s take a look!

    Inspecting the Test Run


    Visit http://localhost:6730/

    Login

    username: superadmin

    password: changeme!

    1. Click on Reports -> Summary in the left sidebar
    2. Select the Run in the drop-down at the top and check the summary
    3. Explore the other reports for this run
    4. Stop the test (-d will stop the test and the cluster)
    browserup load stop -d

    That’s it! You’ve run your first test!

    Cloud Runs

    This quick start focused on a local Docker run, but the process for a remote run is the same, except you’ll need AWS credentials defined, and to set in your browserup.load.yaml:

    cluster_type: aws

    Issues

    If you find any issues, Report them here

    © BrowserUp, Inc. 2023
    Search