cypress-cloud

Setup and usage instruction for cypress-cloud

Please refer to the most recent documentation published in the GitHub repository

We are suspending our support of integration with Cypress starting from version 13.

We will continue to support and provide assistance to the affected customers. Please contact our support channels for details.

Setup

Install the package:

npm install cypress-cloud

Create a new configuration file: currents.config.js in the project’s root, set the projectId and the record key obtained from or your self-hosted instance of Sorry Cypress:

// currents.config.js
module.exports = {
  projectId: "Ij0RfK",
  recordKey: "xxx",
  // Sorry Cypress users - set the director service URL
  cloudServiceUrl: "http://cy.currents.dev",
};

Add cypress-cloud/plugin to cypress.config.{j|t}s

// cypress.config.js
const { defineConfig } = require("cypress");
const { cloudPlugin } = require("cypress-cloud/plugin");
module.exports = defineConfig({
  e2e: {
    // ...
    async setupNodeEvents(on, config) {
      const result = await cloudPlugin(on, config);
      return result;
    },
  },
});

import { defineConfig } from "cypress";
import currents from "cypress-cloud/plugin";

export default defineConfig({
  e2e: {
    // ...
    async setupNodeEvents(on, config) {
      const result = await currents(on, config);
      return result;
    },
  }
});

require("cypress-cloud/support");

Setup with existing plugins

Usage

npx cypress-cloud --parallel --record --ci-build-id hello-cypress-cloud

Documentation

Please refer to the most recent documentation published in the GitHub repository

PreviousReporters NextBatched Orchestration

Last updated 1 year ago

Was this helpful?