Skip to content

Commit 58ad480

Browse files
authored
docs: document new maximum path length error (#4437)
1 parent 820c0d8 commit 58ad480

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

content/guides/references/error-messages.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,38 @@ before finally completing. You must add more groups during that time period.
733733
Please review our [parallelization](/guides/guides/parallelization)
734734
documentation to learn more.
735735

736+
<a name='win-max-path-length'></a>
737+
738+
### <Icon name="exclamation-triangle" color="red"></Icon> The Cypress App could not be unzipped. This is most likely because the maximum path length is being exceeded on your system.
739+
740+
When Cypress is installed, it unzips to the designated cache location on your
741+
computer. This error means that Cypress detected that it has exceeded the
742+
maximum path length while unzipping Cypress.
743+
744+
This is common on Windows, where the maximum path length used to be 260
745+
characters.
746+
747+
To fix this error, enable "long paths" on your Windows system:
748+
749+
1. Go to the Start Menu, and right click on PowerShell. Select "Run as
750+
administrator."
751+
2. Run this command:
752+
753+
```powershell
754+
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
755+
-Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
756+
```
757+
758+
3. Restart your computer.
759+
760+
This should get rid of the error. If you are still receiving this error, please
761+
[search for an open issue](https://github.com/cypress-io/cypress/issues) or
762+
[open a new one](https://github.com/cypress-io/cypress/issues/new/choose).
763+
764+
If you do not have Powershell available, you can also make this change via
765+
regedit or gpedit.
766+
[See Microsoft's documentation for details.](https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation)
767+
736768
## Page Load Errors
737769

738770
### <Icon name="exclamation-triangle" color="red"></Icon> Cypress detected a cross-origin error happened on page load

0 commit comments

Comments
 (0)