Skip to content

Add Cypress uninstall instructions #5995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Add Cypress uninstall instructions #5995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/app/get-started/install-cypress.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ the desired version (ex.
If you have more complex requirements, want to level-up your Cypress workflow or
just need help with troubleshooting, check out our
[Advanced Installation](/app/references/advanced-installation) reference.
You can also find instructions to [uninstall Cypress](/app/references/advanced-installation#Uninstall-Cypress) in this reference documentation.

### <Icon name="sync-alt" /> Continuous integration

Expand Down
45 changes: 45 additions & 0 deletions docs/app/references/advanced-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,3 +414,48 @@ Refer to Microsoft Learn [Windows Subsystem for Linux Documentation](https://lea
Cypress.io does not specifically support the use of Cypress under Windows Subsystem for Linux (WSL). If you want to report an issue, please ensure that you can reproduce it without using WSL on one of the Cypress [supported operating systems](/app/get-started/install-cypress#Operating-System).

:::

## Uninstall Cypress

To uninstall Cypress from a project, use the same package manager you used to [install Cypress](/app/get-started/install-cypress):

<Tabs groupId="package-manager"
defaultValue="npm"
values={[
{label: 'npm', value: 'npm'},
{label: 'Yarn', value: 'yarn'},
{label: 'pnpm', value: 'pnpm'},
]}>
<TabItem value="npm">

```shell
npm uninstall cypress
```

</TabItem>
<TabItem value="yarn">

```shell
yarn remove cypress
```

</TabItem>
<TabItem value="pnpm">

```shell
pnpm remove cypress
```

</TabItem>
</Tabs>

To uninstall all cached Cypress binary versions, use the [cypress cache clear](./command-line#cypress-cache-clear) command with the appropriate package manager prefix described in [How to run commands](./command-line#How-to-run-commands).
Alternatively, delete the [Cypress binary cache](#Binary-cache) (see above) manually.

To delete cached [Cypress App Data](./troubleshooting#Clear-App-Data), manually delete the following directories / folders:

- macOS: `~/Library/Application Support/Cypress`
- Linux: `~/.config/Cypress`
- Windows: `$APPDATA/Cypress` (POSIX-syntax) or `%APPDATA%\Cypress` (Windows-syntax)

Refer to your package manager documentation for details of package manager `cache clean` commands to remove other packages cached by npm, Yarn or pnpm.