Cypress Control

Cypress Control adds a frontend to Cypress to start and stop Cypress, selectively run a subset of specs and to visualize the run in real-time.

Install

npm install @israelnyc/cypress-control

Require Cypress Control in a directory where Cypress is installed.

const cypressControl = require('@israelnyc/cypress-control')();

Runner

The runner can be started via the frontend but is also returned as a result of requiring and starting the server. So it can be started programatically.

const cypressControl = require('@israelnyc/cypress-control')({
    port: 5000,
});

cypressControl.runner.start();

Along with the runner, the socket client and an object containing Cypress Control event constants are also returned, which allows for listening for the custom runner and reporter status events which the server emits.

const cypressControl = require('@israelnyc/cypress-control')({
    port: 5000,
});

const { events, runner, socket } = cypressControl;

socket.on(events.CYPRESS_CONTROL_STATUS, data => {
    if (data.eventType === events.CYPRESS_CONTROL_TEST_END) {
        console.log('test ended');
    }
});

runner.start();

Configuration

Runner Results

View runner results in real-time in the browser via the port the server was started on.