{ "doc": { "id": "app/references/launching-browsers", "title": "Launching Browsers in Cypress", "description": "Learn how to launch browsers in Cypress, customize the list of available browsers, and troubleshoot browser launching issues.", "section": "app", "source_path": "/llm/markdown/app/references/launching-browsers.md", "version": "ce02913654e2655ee63448bdc92bb92c7b46a619", "updated_at": "2026-04-22T19:37:51.587Z", "headings": [ { "id": "app/references/launching-browsers#launching-browsers", "text": "Launching Browsers", "level": 1 }, { "id": "app/references/launching-browsers#what-youll-learn", "text": " What you'll learn", "level": 5 }, { "id": "app/references/launching-browsers#browsers", "text": "Browsers", "level": 2 }, { "id": "app/references/launching-browsers#browser-versions-supported", "text": "Browser versions supported", "level": 3 }, { "id": "app/references/launching-browsers#download-specific-chrome-version", "text": "Download specific Chrome version", "level": 3 }, { "id": "app/references/launching-browsers#electron-browser", "text": "Electron Browser", "level": 3 }, { "id": "app/references/launching-browsers#you-can-also-launch-electron-headed", "text": "You can also launch Electron headed:", "level": 4 }, { "id": "app/references/launching-browsers#chrome-browsers", "text": "Chrome Browsers", "level": 3 }, { "id": "app/references/launching-browsers#chrome-policy", "text": "Chrome policy", "level": 4 }, { "id": "app/references/launching-browsers#edge-browsers", "text": "Edge Browsers", "level": 3 }, { "id": "app/references/launching-browsers#edge-policy", "text": "Edge policy", "level": 4 }, { "id": "app/references/launching-browsers#firefox-browsers", "text": "Firefox Browsers", "level": 3 }, { "id": "app/references/launching-browsers#mozilla-geckodriver", "text": "Mozilla geckodriver", "level": 5 }, { "id": "app/references/launching-browsers#webkit-experimental", "text": "WebKit (Experimental)", "level": 3 }, { "id": "app/references/launching-browsers#linux-dependencies", "text": "Linux Dependencies", "level": 4 }, { "id": "app/references/launching-browsers#known-issues-with-experimentalwebkitsupport", "text": "Known Issues with experimentalWebKitSupport", "level": 4 }, { "id": "app/references/launching-browsers#launching-by-a-path", "text": "Launching by a path", "level": 3 }, { "id": "app/references/launching-browsers#customize-available-browsers", "text": "Customize available browsers", "level": 3 }, { "id": "app/references/launching-browsers#unsupported-browsers", "text": "Unsupported Browsers", "level": 3 }, { "id": "app/references/launching-browsers#browser-environment", "text": "Browser Environment", "level": 2 }, { "id": "app/references/launching-browsers#launching-browsers", "text": "Launching Browsers", "level": 3 }, { "id": "app/references/launching-browsers#cypress-profile", "text": "Cypress Profile", "level": 3 }, { "id": "app/references/launching-browsers#extra-tabs", "text": "Extra Tabs", "level": 3 }, { "id": "app/references/launching-browsers#disabled-barriers", "text": "Disabled Barriers", "level": 3 }, { "id": "app/references/launching-browsers#the-cypress-launched-browser-automatically", "text": "The Cypress launched browser automatically:", "level": 4 }, { "id": "app/references/launching-browsers#browser-icon", "text": "Browser Icon", "level": 2 }, { "id": "app/references/launching-browsers#troubleshooting", "text": "Troubleshooting", "level": 2 }, { "id": "app/references/launching-browsers#see-also", "text": "See also", "level": 2 } ] }, "content": { "type": "root", "children": [ { "type": "heading", "depth": 1, "children": [ { "type": "text", "value": "Launching Browsers" } ] }, { "type": "heading", "depth": 5, "children": [ { "type": "text", "value": " What you'll learn" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to launch browsers in Cypress" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to customize the list of available browsers" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to troubleshoot browser launching issues" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Differences between Cypress browsers and regular browser environments" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When you run tests in Cypress, we launch a browser for you. This enables us to:" } ] }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Create a clean, pristine testing environment." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Access the privileged browser APIs for automation." } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress currently supports Firefox and Chrome-family browsers (including Edge\nand Electron). To run tests optimally across these browsers in CI, check out the\nstrategies demonstrated in the\n" }, { "type": "link", "title": null, "url": "/llm/markdown/app/guides/cross-browser-testing.md", "children": [ { "type": "text", "value": "cross browser Testing" } ] }, { "type": "text", "value": " guide." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When Cypress is initially launched, you can choose to test your application\nusing number of browsers including:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.google.com/chrome/", "children": [ { "type": "text", "value": "Chrome" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.google.com/chrome/beta/", "children": [ { "type": "text", "value": "Chrome Beta" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.google.com/chrome/canary/", "children": [ { "type": "text", "value": "Chrome Canary" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://github.com/GoogleChromeLabs/chrome-for-testing/", "children": [ { "type": "text", "value": "Chrome for Testing" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.chromium.org/Home", "children": [ { "type": "text", "value": "Chromium" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.microsoft.com/edge", "children": [ { "type": "text", "value": "Edge" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.microsoftedgeinsider.com/download", "children": [ { "type": "text", "value": "Edge Beta" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.microsoftedgeinsider.com/download", "children": [ { "type": "text", "value": "Edge Canary" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.microsoftedgeinsider.com/download", "children": [ { "type": "text", "value": "Edge Dev" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://electron.atom.io/", "children": [ { "type": "text", "value": "Electron" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.mozilla.org/firefox/", "children": [ { "type": "text", "value": "Firefox" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.mozilla.org/firefox/developer/", "children": [ { "type": "text", "value": "Firefox Developer Edition" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://www.mozilla.org/firefox/nightly/", "children": [ { "type": "text", "value": "Firefox Nightly" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "#WebKit-Experimental", "children": [ { "type": "text", "value": "WebKit (Experimental)" } ] } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress automatically detects available browsers on your OS. You can switch the\nbrowser by using the drop down near the top right corner:" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Browser versions supported" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress officially supports the latest 3 major versions of Chrome, Firefox, and Edge.\n(For example, if the stable release of Chrome was 130, Cypress would officially support Chrome 128, 129, and 130.)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "See each browser's official release schedule for more information." } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://chromiumdash.appspot.com/schedule", "children": [ { "type": "text", "value": "Chrome Release Schedule" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://whattrainisitnow.com/release/?version=release", "children": [ { "type": "text", "value": "Firefox Release Schedule" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "https://learn.microsoft.com/en-us/deployedge/microsoft-edge-release-schedule#microsoft-edge-releases", "children": [ { "type": "text", "value": "Edge Release Schedule" } ] } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Download specific Chrome version" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The Chrome browser is evergreen - meaning it will automatically update itself,\nsometimes causing a breaking change in your automated tests.\nYou can use the information in " }, { "type": "link", "title": null, "url": "https://on.cypress.io/chromium-downloads", "children": [ { "type": "text", "value": "Download Chromium" } ] }, { "type": "text", "value": " to download a\nspecific released version of Chrome for Testing or Chromium for every platform." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Electron Browser" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "In addition to the browsers found on your system, you'll notice that Electron is\nan available browser. The Electron browser is a version of Chromium that comes\nwith " }, { "type": "link", "title": null, "url": "https://electron.atom.io/", "children": [ { "type": "text", "value": "Electron" } ] }, { "type": "text", "value": "." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The Electron browser has the advantage of coming baked into Cypress and does not\nneed to be installed separately." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By default, when running " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-run", "children": [ { "type": "text", "value": "cypress run" } ] }, { "type": "text", "value": "\nfrom the CLI, we will launch all browsers headlessly." } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "You can also launch Electron headed:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --headed" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Because Electron is the default browser - it is typically run in CI. If you are\nseeing failures in CI, to easily debug them you may want to run locally with the\n`--headed` option." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Chrome Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "All Chrome* flavored browsers are detected and supported by Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can launch Chrome like this:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser chrome" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To use this command in CI, you need to install the browser you want - or use one\nof our " }, { "type": "link", "title": null, "url": "/llm/markdown/app/continuous-integration/overview.md#Cypress-Docker-Images", "children": [ { "type": "text", "value": "docker images" } ] }, { "type": "text", "value": "." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By default, we will launch Chrome headlessly during `cypress run`. To run\nChrome headed, you can pass the `--headed` argument to `cypress run`." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can also launch Chromium:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser chromium" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Chrome Beta:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser chrome:beta" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Chrome Canary:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser chrome:canary" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Chrome for Testing:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser chrome-for-testing" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Chrome policy" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If Chrome policy is set, ensure that\n" }, { "type": "link", "title": null, "url": "https://chromeenterprise.google/policies/#RemoteDebuggingAllowed", "children": [ { "type": "text", "value": "RemoteDebuggingAllowed" } ] }, { "type": "text", "value": "\nis either undefined or set to `true`.\nIf this is not the case, then Cypress will timeout, returning an `ECONNREFUSED` error, attempting to connect to the browser.\nChrome policy is generally applied to a Chrome-branded browser only, not to Chromium or Chrome for Testing browsers.\nCheck by browsing to chrome://policy." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Edge Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Microsoft Edge-family (Chromium-based) browsers are supported by Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can launch Microsoft Edge like this:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser edge" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Microsoft Edge Beta:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser edge:beta" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Microsoft Edge Canary:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser edge:canary" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Microsoft Edge Dev:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser edge:dev" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Edge policy" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If Edge policy is set, ensure that\n" }, { "type": "link", "title": null, "url": "https://learn.microsoft.com/en-us/deployedge/microsoft-edge-browser-policies/remotedebuggingallowed", "children": [ { "type": "text", "value": "RemoteDebuggingAllowed" } ] }, { "type": "text", "value": "\nis either undefined or set to `true`.\nIf this is not the case, then Cypress will timeout, returning an `ECONNREFUSED` error, attempting to connect to the browser.\nCheck by browsing to edge://policy." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Firefox Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Firefox-family browsers are supported by Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can launch Firefox like this:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser firefox" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Or Firefox Developer/Nightly Edition:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser firefox:dev\ncypress run --browser firefox:nightly" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To use this command in CI, you need to install these other browsers - or use one\nof our " }, { "type": "link", "title": null, "url": "/llm/markdown/app/continuous-integration/overview.md#Cypress-Docker-Images", "children": [ { "type": "text", "value": "docker images" } ] }, { "type": "text", "value": "." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By default, we will launch Firefox headlessly during `cypress run`. To run\nFirefox headed, you can pass the `--headed` argument to `cypress run`." } ] }, { "type": "heading", "depth": 5, "children": [ { "type": "text", "value": "Mozilla geckodriver" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress requires the\n" }, { "type": "link", "title": null, "url": "https://github.com/mozilla/geckodriver", "children": [ { "type": "text", "value": "Mozilla geckodriver" } ] }, { "type": "text", "value": " to launch Firefox.\nTo meet this requirement, the Cypress binary uses the separate npm wrapper package\n" }, { "type": "link", "title": null, "url": "https://github.com/webdriverio-community/node-geckodriver", "children": [ { "type": "text", "value": "geckodriver" } ] }, { "type": "text", "value": "\nto provide the Mozilla geckodriver.\nThe wrapper downloads the latest driver version if it does not find any driver version cached locally." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Retrieving the driver may fail if you are operating Cypress in an air-gapped environment without Internet connectivity and you do not have a cached driver version available." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To avoid this issue, use a current\n" }, { "type": "link", "title": null, "url": "/llm/markdown/app/continuous-integration/overview.md#Cypress-Docker-Images", "children": [ { "type": "text", "value": "Cypress Docker image" } ] }, { "type": "text", "value": " `cypress/browsers` or `cypress/included`, built with Firefox 139, or above.\nThese images include a Mozilla geckodriver version pre-installed.\nUsing `cypress/factory:5.9.0`, or above, you can also build your own custom Cypress Docker image that includes a Mozilla geckodriver version.\nRefer to the `cypress/factory`\n" }, { "type": "link", "title": null, "url": "https://github.com/cypress-io/cypress-docker-images/blob/master/factory/README.md", "children": [ { "type": "text", "value": "documentation" } ] }, { "type": "text", "value": " for instructions on building custom images." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you need to work without Docker, refer to the npm wrapper package geckodriver\n" }, { "type": "link", "title": null, "url": "https://github.com/webdriverio-community/node-geckodriver", "children": [ { "type": "text", "value": "documentation" } ] }, { "type": "text", "value": " for information\nabout how to define a custom path for the driver or how to refer to a local CDN mirror site.\nDownload the Mozilla geckodriver from the\n" }, { "type": "link", "title": null, "url": "https://github.com/mozilla/geckodriver/releases", "children": [ { "type": "text", "value": "releases" } ] }, { "type": "text", "value": " location." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "WebKit (Experimental)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress has " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/experiments.md", "children": [ { "type": "text", "value": "experimental" } ] }, { "type": "text", "value": " support for WebKit,\nSafari's browser engine. Testing your app with WebKit is representative of how\nyour app would run in Safari. To opt-in to `experimentalWebKitSupport`, follow\nthese steps:" } ] }, { "type": "list", "ordered": true, "start": 1, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Add `experimentalWebKitSupport: true` to your\n" }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md", "children": [ { "type": "text", "value": "configuration" } ] }, { "type": "text", "value": " to enable the experiment." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "For installation on Linux, refer to " }, { "type": "link", "title": null, "url": "#Linux-Dependencies", "children": [ { "type": "text", "value": "Linux Dependencies" } ] }, { "type": "text", "value": " below." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Install the `playwright-webkit` npm package in your repo to acquire WebKit\nitself:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "npm install playwright-webkit --save-dev" } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Now, you should be able to use WebKit like any other browser. For example, to\nrecord with WebKit in CI:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser webkit --record # ..." } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "We built this experiment on top of the Playwright WebKit browser as a\nstepping stone towards creating a better UX with Cypress-provided browsers\nin the future. Thank you, Playwright contributors." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "WebKit support is experimental, so you may encounter issues. If you encounter\nan issue not on the \"Known Issues\" list, please\n" }, { "type": "link", "title": null, "url": "https://github.com/cypress-io/cypress/issues/new/choose", "children": [ { "type": "text", "value": "open an issue" } ] }, { "type": "text", "value": " on the\nGitHub repository." } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Linux Dependencies" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "WebKit requires additional dependencies to run on Linux. To install the required\ndependencies, run this:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "npx playwright install-deps webkit" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Known Issues with experimentalWebKitSupport" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.origin()` is not yet supported." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.intercept()`'s `forceNetworkError` option is disabled." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "When using `experimentalSingleTabRunMode` with video recording in WebKit, only\nthe video for the first spec is recorded." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Some differences in `cy.type()` behavior:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`textInput` events are missing the `data` property" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`beforeinput` events are missing the `inputType` property" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.type('{uparrow}')` and `cy.type('{downarrow}')` on an\n`input[type=number]` do not round to the nearest `step` specified" } ] } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Stack traces may be missing some function names and location information." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "See issues labeled\n" }, { "type": "link", "title": null, "url": "https://github.com/cypress-io/cypress/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22experiment%3A+webkit%22", "children": [ { "type": "text", "value": "`experiment: webkit`" } ] }, { "type": "text", "value": "\nfor a complete list." } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Launching by a path" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can launch any supported browser by specifying a path to the binary:" } ] }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress run --browser /usr/bin/chromium" }, { "type": "code", "lang": "shell", "meta": null, "value": "cypress open --browser /usr/bin/chromium" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress will automatically detect the type of browser supplied and launch it for\nyou." } ] }, { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-run-browser-lt-browser-name-or-path-gt", "children": [ { "type": "text", "value": "See the Command Line guide for more information about the `--browser` arguments" } ] } ] }, { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/troubleshooting.md#Launching-browsers", "children": [ { "type": "text", "value": "Having trouble launching a browser? Check out our troubleshooting guide" } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Customize available browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Sometimes you might want to modify the list of browsers found before running\ntests." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "For example, your web application might only be designed to work in a Chrome\nbrowser, and not inside the Electron browser." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "In the " }, { "type": "link", "title": null, "url": "/llm/markdown/api/node-events/configuration-api.md", "children": [ { "type": "text", "value": "setupNodeEvents" } ] }, { "type": "text", "value": " function, you can\nfilter the list of browsers passed inside the `config` object and return the\nlist of browsers you want available for selection during `cypress open`." } ] }, { "type": "code", "lang": "ts", "meta": null, "value": "// inside config.browsers array each object has information like\n// {\n// name: 'chrome',\n// channel: 'canary',\n// family: 'chromium',\n// displayName: 'Chrome Canary',\n// version: '133.0.6890.0',\n// path:\n// '/Applications/Google Chrome Canary.app/Contents/MacOS/Canary',\n// majorVersion: 133\n// }\nreturn {\n browsers: config.browsers.filter(\n (b) => b.family === 'chromium' && b.name !== 'electron'\n ),\n}" }, { "type": "paragraph", "children": [ { "type": "text", "value": "When you open Cypress in a project that uses the above modifications to the\n`setupNodeEvents` function, Electron will no longer display in the list of\navailable browsers." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you return an empty list of browsers or `browsers: null`, the default list\nwill be restored automatically." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you have installed a Chromium-based browser like " }, { "type": "link", "title": null, "url": "https://brave.com/", "children": [ { "type": "text", "value": "Brave" } ] }, { "type": "text", "value": ",\n" }, { "type": "link", "title": null, "url": "https://vivaldi.com/", "children": [ { "type": "text", "value": "Vivaldi" } ] }, { "type": "text", "value": " you can add them to the list of returned\nbrowsers. Here is a configuration that inserts a local Brave browser into the\nreturned list." } ] }, { "type": "code", "lang": "ts", "meta": null, "value": "import execa from 'execa'\nconst findBrowser = () => {\n // the path is hard-coded for simplicity\n const browserPath =\n '/Applications/Brave Browser.app/Contents/MacOS/Brave Browser'\n\n return execa(browserPath, ['--version']).then((result) => {\n // STDOUT will be like \"Brave Browser 77.0.69.135\"\n const [, version] = /Brave Browser (\\d+\\.\\d+\\.\\d+\\.\\d+)/.exec(result.stdout)\n const majorVersion = parseInt(version.split('.')[0])\n\n return {\n name: 'Brave',\n channel: 'stable',\n family: 'chromium',\n displayName: 'Brave',\n version,\n path: browserPath,\n majorVersion,\n }\n })\n}" }, { "type": "code", "lang": "ts", "meta": null, "value": "return findBrowser().then((browser) => {\n return {\n browsers: config.browsers.concat(browser),\n }\n})" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Once selected, the Brave browser is detected using the same approach as any\nother browser of the `chromium` family." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you modify the list of browsers, you can see the\n" }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md#Resolved-Configuration", "children": [ { "type": "text", "value": "resolved configuration" } ] }, { "type": "text", "value": "\nin the Settings tab." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Unsupported Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Some browsers such as Internet Explorer are not currently supported." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Browser Environment" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress launches the browser in a way that's different from a regular browser\nenvironment. But it launches in a way that we believe makes testing more\nreliable and accessible." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Launching Browsers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When Cypress goes to launch your browser it will give you an opportunity to\nmodify the arguments used to launch the browser." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "This enables you to do things like:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Load your own extension" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Enable or disable experimental features" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/node-events/browser-launch-api.md", "children": [ { "type": "text", "value": "This part of the API is documented here." } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Cypress Profile" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress generates its own isolated profile apart from your normal browser\nprofile. This means things like `history` entries, `cookies`, and\n`3rd party extensions` from your regular browsing session will not affect your\ntests in Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Wait, I need my developer extensions!" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "That's no problem - you have to reinstall them once in the Cypress launched\nbrowser. We'll continue to use this Cypress testing profile on subsequent\nlaunches so all of your configuration will be preserved." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Extra Tabs" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Any extra tabs (i.e. tabs other than the one opened by Cypress) will be closed between tests. We recommend using your own browser instead of the one launched by Cypress for general-purpose browsing." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Disabled Barriers" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress automatically disables certain functionality in the Cypress launched\nbrowser that tend to get in the way of automated testing." } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "The Cypress launched browser automatically:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Ignores certificate errors." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Allows blocked pop-ups." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables 'Saving passwords'." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables 'Autofill forms and passwords'." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables asking to become your primary browser." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables device discovery notifications." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables language translations." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables restoring sessions." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables background network traffic." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables background and renderer throttling." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables prompts requesting permission to use devices like cameras or mics" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Disables user gesture requirements for autoplaying videos." } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can see all of the default chrome command line switches we send\n" }, { "type": "link", "title": null, "url": "https://github.com/cypress-io/cypress/blob/develop/packages/server/lib/browsers/chrome.ts#L36", "children": [ { "type": "text", "value": "here" } ] }, { "type": "text", "value": "." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Browser Icon" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You might notice that if you already have the browser open you will see two of\nthe same browser icons in your dock." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "We understand that when Cypress is running in its own profile it can be\ndifficult to tell the difference between your normal browser and Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "For this reason you may find downloading and using a browser's release channel\nversions (Dev, Canary, etc) useful. These browsers have different icons from the\nstandard stable browser, making them more distinguishable. You can also use the\nbundled " }, { "type": "link", "title": null, "url": "#Electron-Browser", "children": [ { "type": "text", "value": "Electron browser" } ] }, { "type": "text", "value": ", which does not have a dock icon." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Additionally, in Chrome-based browsers, we've made the browser spawned by\nCypress look different than regular sessions. You'll see a darker theme around\nthe chrome of the browser. You'll always be able to visually distinguish these." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Troubleshooting" } ] }, { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/troubleshooting.md#Launching-browsers", "children": [ { "type": "text", "value": "Having issues launching installed browsers? Read more about troubleshooting browser launching" } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "See also" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/node-events/browser-launch-api.md", "children": [ { "type": "text", "value": "Browser Launch API" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/guides/cross-browser-testing.md", "children": [ { "type": "text", "value": "Cross browser Testing" } ] } ] } ] } ] } ] }, "token_estimate": 2755 }