{"id":20337950,"url":"https://github.com/runsidekick/sidekick-cypress-plugin","last_synced_at":"2025-06-12T16:08:46.290Z","repository":{"id":65347863,"uuid":"572502471","full_name":"runsidekick/sidekick-cypress-plugin","owner":"runsidekick","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-22T06:48:16.000Z","size":87,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-14T22:46:11.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runsidekick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-30T12:16:11.000Z","updated_at":"2022-12-27T13:10:24.000Z","dependencies_parsed_at":"2023-01-30T06:00:40.089Z","dependency_job_id":null,"html_url":"https://github.com/runsidekick/sidekick-cypress-plugin","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-cypress-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-cypress-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-cypress-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-cypress-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runsidekick","download_url":"https://codeload.github.com/runsidekick/sidekick-cypress-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241863050,"owners_count":20032927,"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":[],"created_at":"2024-11-14T21:10:59.813Z","updated_at":"2025-03-04T14:27:04.565Z","avatar_url":"https://github.com/runsidekick.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"30%\" height=\"30%\" src=\"https://4750167.fs1.hubspotusercontent-na1.net/hubfs/4750167/Sidekick%20OS%20repo/logo-1.png\"\u003e\n\u003c/p\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.runsidekick.com/discord-invitation?utm_source=sidekick-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/discord/958745045308174416?style=for-the-badge\u0026logo=discord\u0026label=DISCORD\" alt=\"Sidekick Discord Channel\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://www.runforesight.com?utm_source=sidekick-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Monitored%20by-Foresight-%239900F0?style=for-the-badge\" alt=\"Foresight monitoring\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://app.runsidekick.com/sandbox?utm_source=sidekick-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/try%20in-sandbox-brightgreen?style=for-the-badge\" alt=\"Sidekick Sandbox\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \n\u003c/p\u003e\n\n  \u003ch3 align=\"center\"\u003eCypress Sidekick Plugin\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Sidekick plugin for Cypress. Bring Sidekick Actions to Cypress!\n    \u003cbr /\u003e\n    \u003ca href=\"https://docs.runsidekick.com/\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://www.runsidekick.com\"\u003eSidekick Home\u003c/a\u003e\n    ·\n    \u003ca href=\"https://www.runsidekick.com/contact-us\"\u003eReport Bug \u0026 Request Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-recipe\"\u003eAbout\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#example-usage\"\u003eExample Usage\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About Sidekick\n\nSidekick is a production debugging and on-demand logging tool where you can debug your running applications while they keep on running. Sidekick provides the ability to add logs and put non-breaking breakpoints in your application code which captures the snapshot of the application state, the call stack, variables, etc.\n\nSidekick Actions:\n* A tracepoint is basically a non-breaking remote breakpoint. In short, it takes a snapshot of the variables when the code hits that line.\n* Logpoints open the way for dynamic logging to Sidekick users. Replacing traditional logging with dynamic logging has the potential to lower stage sizes, costs, and time for log searching while adding the ability to add new logpoints without editing the source code, redeploying or restarting the application\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n### Built With\n\n* [Sidekick Node.js Client](https://www.npmjs.com/package/@runsidekick/sidekick-agent-nodejs)\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n### Prerequisites\n\nTested with node v16.14.2\n* npm\n  ```sh\n  npm install npm@latest -g\n  ```\n\n\n\u003c!-- GETTING STARTED --\u003e\n# Getting Started\n\n\n## Installation\n\n1. Install Cypress Sidekick Plugin\n   ```sh \n   $ npm i @runsidekick/cypress\n   ```\n\n## Example usage\n\n\n###  Put tracepoint on a line\n  1. Add Sidekick configs into cypress.config.js\n      ```js\n        module.exports = defineConfig({\n            e2e: {\n                sidekickApiKey: '',\n                sidekickApiToken: '',\n                sidekickTestModeApiKey: '',\n                sidekickTestModeHost: '',\n                sidekickTestModePort: 80\n            }\n        })\n      ```\n\n  2. Import Sidekick plguin into Support/e2e.js\n      ```js\n        import ‘@runsidekick/cypress’\n\n      ```\n  3. Call `putTracepoint` function\n      ```js\n        it('putTracepoint', () =\u003e {\n            const putTracepointRequest = {\n                \"applicationFilters\": [\n                    {\n                        \"name\": \"sidekick-demo-app\",\n                        \"version\": \"1.0\",\n                        \"stage\": \"lab\",\n                        \"customTags\": {}\n                    }\n                ],\n                \"fileName\": \"/app/routes/speakers.js\",\n                \"lineNo\": 24,\n                \"expireSecs\": 300,\n                \"expireCount\": 100,\n                \"persist\": true\n            }\n            \n            cy.putTracepoint(putTracepointRequest);\n        })\n      ```\n\n  Then your tracepoint will be added to `line 24` in the given file. \n\n\u003cbr\u003e\n\n \n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nSidekick: [website](https://www.runsidekick.com)\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunsidekick%2Fsidekick-cypress-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunsidekick%2Fsidekick-cypress-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunsidekick%2Fsidekick-cypress-plugin/lists"}