From 2c68020ebdfa500a656e250b9676032a685f9850 Mon Sep 17 00:00:00 2001 From: Zach Bloomquist Date: Tue, 12 Apr 2022 12:10:16 -0400 Subject: [PATCH] docs: document new maximum path length error --- content/guides/references/error-messages.md | 32 +++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/content/guides/references/error-messages.md b/content/guides/references/error-messages.md index 8fa22e74c7..909580eb0c 100644 --- a/content/guides/references/error-messages.md +++ b/content/guides/references/error-messages.md @@ -733,6 +733,38 @@ before finally completing. You must add more groups during that time period. Please review our [parallelization](/guides/guides/parallelization) documentation to learn more. + + +### The Cypress App could not be unzipped. This is most likely because the maximum path length is being exceeded on your system. + +When Cypress is installed, it unzips to the designated cache location on your +computer. This error means that Cypress detected that it has exceeded the +maximum path length while unzipping Cypress. + +This is common on Windows, where the maximum path length used to be 260 +characters. + +To fix this error, enable "long paths" on your Windows system: + +1. Go to the Start Menu, and right click on PowerShell. Select "Run as + administrator." +2. Run this command: + +```powershell +New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" ` + -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force +``` + +3. Restart your computer. + +This should get rid of the error. If you are still receiving this error, please +[search for an open issue](https://github.com/cypress-io/cypress/issues) or +[open a new one](https://github.com/cypress-io/cypress/issues/new/choose). + +If you do not have Powershell available, you can also make this change via +regedit or gpedit. +[See Microsoft's documentation for details.](https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation) + ## Page Load Errors ### Cypress detected a cross-origin error happened on page load