mirror of
https://github.com/cypress-io/cypress.git
synced 2026-04-21 22:49:16 -05:00
Jennifer Shehane
24ba72f423
* Update cli readme to include link to npm module / add new responsibilities * lowercase npm [skip ci]
59 lines
1.7 KiB
Markdown
59 lines
1.7 KiB
Markdown
# CLI
|
|
|
|
The CLI is used to build the [cypress npm module](https://www.npmjs.com/package/cypress) to be run within a terminal.
|
|
|
|
**The CLI has the following responsibilities:**
|
|
|
|
- Allow users to print CLI commands
|
|
- Allow users to install the Cypress executable
|
|
- Allow users to print their current Cypress version
|
|
- Allow users to run Cypress tests from the terminal
|
|
- Allow users to open Cypress in the interactive Test Runner.
|
|
- Allow users to verify that Cypress is installed correctly and executable
|
|
- Allow users to manages the Cypress binary cache
|
|
- Allow users to pass in options that change way tests are ran or recorded (browsers used, specfiles ran, grouping, parallelization)
|
|
|
|
## Installing
|
|
|
|
The CLI's dependencies can be installed with:
|
|
|
|
```bash
|
|
cd cli
|
|
npm install
|
|
```
|
|
|
|
## Building
|
|
|
|
See `scripts/build.js`. Note that the built npm package will include [NPM_README.md](NPM_README.md) as its public README file.
|
|
|
|
## Testing
|
|
|
|
## Automated
|
|
|
|
You can run unit tests with:
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
This will take and compare snapshots of the CLI output. To update snapshots, see `snap-shot-it` instructions: https://github.com/bahmutov/snap-shot-it#advanced-use
|
|
|
|
### Manual
|
|
|
|
To build and test an NPM package:
|
|
|
|
- `npm install`
|
|
- `npm run build`
|
|
|
|
This creates `build` folder.
|
|
|
|
- `cd build; npm pack`
|
|
|
|
This creates an archive, usually named `cypress-<version>.tgz`. You can install this archive from other projects, but because there is no corresponding binary yet (probably), skip binary download. For example from inside `cypress-example-kitchensink` folder
|
|
|
|
```shell
|
|
npm i ~/{your-dirs}/cypress/cli/build/cypress-3.3.1.tgz --ignore-scripts
|
|
```
|
|
|
|
Which installs the `tgz` file we have just built from folder `Users/jane-lane/{your-dirs}/cypress/cli/build`.
|