JSPM

Cypress CLI

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
• Generating API Keys

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 update

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.

## by default will install the latest version
cypress install

## install a specific version
cypress install --cypress-version 0.13.0

Additionally if you have a CYPRESS_VERSION environment variable set, it will automatically download that version. Useful in CI.

cypress update

Updates Cypress to the latest version. This does the same thing as cypress install.

## now we have the latest version
cypress update

cypress run

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

## by default will use your current path
cypress run

## or you can specify a path to the project
cypress run /users/john/projects/TodoMVC

## specify a port to use which overrides values in cypress.json
cypress run --port 8080

## specify a mocha reporter to use
cypress run --reporter json

## specify a spec to run instead of running all the tests
cypress run --spec app_spec.js

## specify environment variables
cypress run --env host=api.dev.local

You can read more about environment variables here.

cypress ci

Run Cypress headlessly in CI. Read the Continuous Integration docs for examples.

## provide the CI secret key directly
cypress ci 1234-abcd-efgh-9876

## or if its setup in an env variable called CYPRESS_CI_KEY
cypress ci

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.

Upcoming Commands

These commands have not yet been released:

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