Skip to content

Commit

Permalink
Harmonize cypress script example names cy: (#5787)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 authored Apr 19, 2024
1 parent 5b1a007 commit b221c90
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/guides/getting-started/opening-the-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ the `scripts` field in your `package.json` file.
```javascript
{
"scripts": {
"cypress:open": "cypress open"
"cy:open": "cypress open"
}
}
```

Now you can invoke the command from your project root like so:

```shell
npm run cypress:open
npm run cy:open
```

...and Cypress will open right up for you.
Expand All @@ -83,7 +83,7 @@ npm run cypress:open
Don't use `cypress` as the exact name of a script, especially if you use Yarn as package manager.
When running commands on the Cypress binary (e.g. `yarn cypress verify`), Yarn will reference the
script of the same name instead and [Cypress CLI commands](/guides/guides/command-line) may not work as expected.
Use instead a descriptive and non-ambiguous script name such as `cypress:open` or `cypress:run`.
Use instead a descriptive and non-ambiguous script name such as `cy:open` or `cy:run`.

:::

Expand Down

0 comments on commit b221c90

Please sign in to comment.