{"id":20560113,"url":"https://github.com/webdriverio-community/wdio-chromedriver-service","last_synced_at":"2025-05-09T17:33:01.812Z","repository":{"id":42126538,"uuid":"90821323","full_name":"webdriverio-community/wdio-chromedriver-service","owner":"webdriverio-community","description":"WebdriverIO service to start \u0026 stop ChromeDriver","archived":true,"fork":false,"pushed_at":"2023-08-03T23:56:12.000Z","size":4940,"stargazers_count":35,"open_issues_count":4,"forks_count":26,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-17T02:02:43.140Z","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/webdriverio-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"atti187"}},"created_at":"2017-05-10T04:36:28.000Z","updated_at":"2025-03-30T11:32:42.000Z","dependencies_parsed_at":"2024-06-18T13:45:49.977Z","dependency_job_id":null,"html_url":"https://github.com/webdriverio-community/wdio-chromedriver-service","commit_stats":{"total_commits":209,"total_committers":24,"mean_commits":8.708333333333334,"dds":"0.49282296650717705","last_synced_commit":"00a0844228fbadee7071d829e2caafe705423a74"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio-community%2Fwdio-chromedriver-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio-community%2Fwdio-chromedriver-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio-community%2Fwdio-chromedriver-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio-community%2Fwdio-chromedriver-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdriverio-community","download_url":"https://codeload.github.com/webdriverio-community/wdio-chromedriver-service/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253295796,"owners_count":21885695,"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-16T03:53:12.937Z","updated_at":"2025-05-09T17:33:01.340Z","avatar_url":"https://github.com/webdriverio-community.png","language":"TypeScript","funding_links":["https://github.com/sponsors/atti187"],"categories":["Plugins"],"sub_categories":["Services"],"readme":"⚠️ __DEPRECATION WARNING:__ This service got deprecated and is no longer maintained. If you use WebdriverIO __v8.14__ or higher. We recommend to remove the service as dependency and from your WebdriverIO configuration as it is no longer needed. For more information, please read [this blog post](https://webdriver.io/blog/2023/07/31/driver-management).\n\nWDIO ChromeDriver Service\n=========================\n\nThis service helps you to run ChromeDriver seamlessly when running tests with the [WDIO testrunner](http://webdriver.io/guide/testrunner/gettingstarted.html). It uses the [chromedriver](https://www.npmjs.com/package/chromedriver) NPM package that wraps ChromeDriver for you.\n\n__Note:__ this service does not require a Selenium server, but uses ChromeDriver to communicate with the browser directly.\n\nObviously, it only supports:\n\n```js\ncapabilities: [{\n    browserName: 'chrome'\n}]\n```\n\n## Installation\n\nThe easiest way is to keep `wdio-chromedriver-service` as a devDependency in your `package.json`.\n\n```json\n{\n  \"devDependencies\": {\n    \"wdio-chromedriver-service\": \"^8.0.0\"\n  }\n}\n```\n\nYou can do it by:\n\n```bash\nnpm install wdio-chromedriver-service --save-dev\n```\n\n__Note:__ You have to install [chromedriver](https://www.npmjs.com/package/chromedriver) separately, as it's a peerDependency of this project, and you're free to choose which version to use. Depending of which version of Chrome you have installed on your system you should install the same version of `chromedriver`. Install it using:\n\n```bash\nnpm install chromedriver --save-dev\n# if you have Chrome 104 installed on your machine do\nnpm install chromedriver@104 --save-dev\n```\n\nInstructions on how to install `WebdriverIO` can be found [here](https://webdriver.io/docs/gettingstarted).\n\n## Configuration\n\nBy design, only Google Chrome is available (when installed on the host system). In order to use the service you need to add `chromedriver` to your service array:\n\n```js\n// wdio.conf.js\nexport.config = {\n  outputDir: 'all-logs',\n  // ...\n  services: [\n    ['chromedriver', {\n        logFileName: 'wdio-chromedriver.log', // default\n        outputDir: 'driver-logs', // overwrites the config.outputDir\n        args: ['--silent']\n    }]\n  ],\n  // ...\n};\n```\n\n## Options\n\n### port\nThe port on which the driver should run on\n\nExample: 9515\n\nType: `number`\n\n### path\nThe path on which the driver should run on\n\nExample: `/`\n\nType: `string`\n\n### protocol\nThe protocol on which the driver should use\n\nExample: `http`\n\nType: `string`\n\n### hostname\nThe protocol on which the driver should use\n\nExample: `localhost`\n\nType: `string`\n\n### pollTimeout\nThe startup timeout in ms, it checks if the port is open before starting ChromeDriver and then checks again if the it is closed after starting it.\n\nExample: `10000`\n\nType: `number`\n\n### outputDir\nThe path where the output of the ChromeDriver server should be stored (uses the config.outputDir by default when not set).\n\nExample: `driver-logs`\n\nType: `string`\n\n### logFileName\nThe name of the log file to be written in `outputDir`.\n\nExample: `wdio-chromedriver.log`\n\nType: `string`\n\n### chromedriverCustomPath\nTo use a custom chromedriver different than the one installed through the \"chromedriver npm module\", provide the path.\n\nExample: `/path/to/chromedriver` (Linux / MacOS), `./chromedriver.exe` or `d:/driver/chromedriver.exe` (Windows)\n\nType: `string`\n\n---\n\nFor more information on WebdriverIO see the [homepage](https://webdriver.io).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdriverio-community%2Fwdio-chromedriver-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdriverio-community%2Fwdio-chromedriver-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdriverio-community%2Fwdio-chromedriver-service/lists"}