JSPM

cypress

0.7.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6250176
  • Score
    100M100P100Q229000F
  • License MIT

CLI for Cypress.io Desktop App

Package Exports

  • cypress/bin/cypress
  • cypress/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cypress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cypress CLI Circle CI

This is the CLI for https://github.com/cypress-io/cypress.

What this does

This CLI enables you to interact with the Cypress Desktop Application through the command line. This is helpful for both local development and running Cypress on a CI server.

For instance you can do common tasks like:

  • Installing Cypress
  • Running Cypress Headlessly
  • Logging into Cypress
  • Generating API Keys
  • Adding Projects

Installation

npm install -g cypress

This will make the cypress command globally available from your command line.

You can now execute the following commands:

Available Commands

cypress install
cypress run
cypress ci
cypress open
cypress get:path
cypress get:key
cypress new:key
cypress verify

--

cypress install

Installs Cypress to the default location for each Operating System.

OS Path
Mac /Applications/Cypress.app
Linux /home/<user>/.cypress/Cypress

cypress run

Runs Cypress headlessly. By default will run all your tests. Useful when developing locally.

cypress ci

Run Cypress headlessly in CI. Expects your CI provider to have XVFB installed.

Note: Most CI Providers will already have XVFB installed.

cypress open

Opens the Cypress application. This is the same thing as double-clicking the application.

In Mac you'll see the Cy icon in the tray, and in Linux you'll see the Cypress application window open.

cypress get:path

Returns the path Cypress will be install to. Additionally checks to see if Cypress already exists at that path.

cypress get:key

Returns your secret project key for use in CI.

cypress new:key

Creates a new secret project key and returns that key for use in CI. This will negate previous secret keys, so be sure to update your CI to use this new key.

cypress verify

Verifies that the Cypress application is found and is executable.

Upcoming Commands

These commands have not yet been released:

cypress update
cypress login
cypress set:path
cypress add:project
cypress remove:project

Contributing

 npm test                                             ## run tests
 npm run test-debug                                   ## run tests w/node inspector
 npm version [major | minor | patch] -m "release %s"  ## update version
 npm publish                                          ## publish to npm