{"id":15552146,"url":"https://github.com/bahmutov/cypress-high-resolution","last_synced_at":"2025-09-28T23:31:35.142Z","repository":{"id":37440542,"uuid":"422297868","full_name":"bahmutov/cypress-high-resolution","owner":"bahmutov","description":"A plugin to increase the video resolution for cypress run","archived":false,"fork":false,"pushed_at":"2024-12-18T03:28:58.000Z","size":178,"stargazers_count":14,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-27T20:14:31.878Z","etag":null,"topics":["cypress-plugin"],"latest_commit_sha":null,"homepage":"https://www.cypress.io/blog/2021/03/01/generate-high-resolution-videos-and-screenshots/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bahmutov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-28T17:32:56.000Z","updated_at":"2024-08-05T17:41:21.000Z","dependencies_parsed_at":"2024-05-22T03:30:25.483Z","dependency_job_id":"df6a1d8b-d369-4928-b012-644a46777a8b","html_url":"https://github.com/bahmutov/cypress-high-resolution","commit_stats":{"total_commits":67,"total_committers":4,"mean_commits":16.75,"dds":0.5671641791044777,"last_synced_commit":"7233bf610a4dea612873c04d6cf10f19b228d56b"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fcypress-high-resolution","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fcypress-high-resolution/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fcypress-high-resolution/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fcypress-high-resolution/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bahmutov","download_url":"https://codeload.github.com/bahmutov/cypress-high-resolution/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234570390,"owners_count":18854156,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cypress-plugin"],"created_at":"2024-10-02T14:09:33.377Z","updated_at":"2025-09-28T23:31:29.759Z","avatar_url":"https://github.com/bahmutov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cypress-high-resolution [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-12.3.0-brightgreen) [![cypress-high-resolution](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/e44x4z/main\u0026style=flat\u0026logo=cypress)](https://dashboard.cypress.io/projects/e44x4z/runs) [![ci](https://github.com/bahmutov/cypress-high-resolution/actions/workflows/ci.yml/badge.svg?branch=main\u0026event=push)](https://github.com/bahmutov/cypress-high-resolution/actions/workflows/ci.yml)\n\n\u003e A plugin to increase the video resolution for cypress run\n\nBased on the blog post [Generate High-Resolution Videos and Screenshots](https://www.cypress.io/blog/2021/03/01/generate-high-resolution-videos-and-screenshots/) and watch how to use this plugin in the video [Create High Resolution Videos And Screenshots In Cypress Using This Plugin](https://youtu.be/jAU4dLRXVIA).\n\n## Install\n\nAdd this plugin to your project as a dev dependency\n\n```\n# install using NPM\n$ npm i -D cypress-high-resolution\n# or install using Yarn\n$ yarn add -D cypress-high-resolution\n```\n\n### Cypress v10+\n\nAdd this plugin to your Cypress config file\n\n```js\n// cypress.config.js\nconst { defineConfig } = require('cypress')\n\nmodule.exports = defineConfig({\n  e2e: {\n    setupNodeEvents(on, config) {\n      // https://github.com/bahmutov/cypress-high-resolution\n      return require('cypress-high-resolution')(on, config)\n    },\n  },\n})\n```\n\n### Cypress v9\n\nAdd this plugin to your Cypress plugin file\n\n```js\n// cypress/plugins/index.js\nmodule.exports = (on, config) =\u003e {\n  // https://github.com/bahmutov/cypress-high-resolution\n  require('cypress-high-resolution')(on, config)\n}\n```\n\n## Use\n\nWhen using non-interactive mode `cypress run`, you can specify the browser window size using the [Cypress environment variables](https://on.cypress.io/environment-variables) which can be passed via system OS environment variables, via `cypress.json` config file, via `cypress.env.json` file, or via command line arguments. For example, here is how to specify the video resolution using the command line arguments:\n\n```\n# generate ultra-high resolution 3840x2160 videos\n$ npx cypress run --env resolution=4k\n# generate videos 1200x1000\n$ npx cypress run --env resolution=1200x1000\n# alternative way: use an array\n$ npx cypress run --env resolution=[1200,1000]\n# generate high resolution video 1920x1080\n$ npx cypress run --env resolution=high\n```\n\nSpecifying the output resolution using the system OS variables\n\n```\n# 1920x1080 videos\nCYPRESS_resolution=high npx cypress run\n# small videos\nCYPRESS_resolution=600x300 npx cypress run\n```\n\nYou can set the video resolution in the `cypress.json` file\n\n```json\n{\n  \"env\": {\n    \"resolution\": [1280, 720]\n  }\n}\n```\n\nOr a high resolution\n\n```json\n{\n  \"env\": {\n    \"resolution\": \"high\"\n  }\n}\n```\n\n**Tip:** when increasing the browser window size, it might make sense to increase the viewport used by the Cypress to use those pixels!\n\n## Debugging\n\nThis plugin uses [debug](https://github.com/visionmedia/debug#readme) module to output verbose messages. Start Cypress with the environment variable `DEBUG=cypress-high-resolution` to see them. How to set an environment variable depends on the operating system. From a Linux terminal we can use\n\n```shell\n$ DEBUG=cypress-high-resolution npx cypress run\n```\n\n## See also\n\n- [Make Cypress Videos Look Old School](https://www.cypress.io/blog/2021/04/01/make-cypress-videos-look-old-school/)\n\n## Small print\n\nAuthor: Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt; \u0026copy; 2021\n\n- [@bahmutov](https://twitter.com/bahmutov)\n- [glebbahmutov.com](https://glebbahmutov.com)\n- [blog](https://glebbahmutov.com/blog)\n- [videos](https://www.youtube.com/glebbahmutov)\n- [presentations](https://slides.com/bahmutov)\n- [cypress.tips](https://cypress.tips)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/cypress-high-resolution/issues) on Github\n\n## MIT License\n\nCopyright (c) 2021 Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt;\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\n[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg\n[renovate-app]: https://renovateapp.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fcypress-high-resolution","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbahmutov%2Fcypress-high-resolution","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fcypress-high-resolution/lists"}