1<!doctype html> 2<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-gettingstarted" data-has-hydrated="false"> 3<head> 4<meta charset="UTF-8"> 5<meta name="generator" content="Docusaurus v3.9.2"> 6<title data-rh="true">Getting Started | WebdriverIO</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" property="og:image" content="https://webdriver.io/img/logo-webdriver-io.png"><meta data-rh="true" name="twitter:image" content="https://webdriver.io/img/logo-webdriver-io.png"><meta data-rh="true" property="og:url" content="https://webdriver.io/docs/gettingstarted"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="ar"><meta data-rh="true" property="og:locale:alternate" content="de"><meta data-rh="true" property="og:locale:alternate" content="es"><meta data-rh="true" property="og:locale:alternate" content="fr"><meta data-rh="true" property="og:locale:alternate" content="hi"><meta data-rh="true" property="og:locale:alternate" content="it"><meta data-rh="true" property="og:locale:alternate" content="ko"><meta data-rh="true" property="og:locale:alternate" content="pl"><meta data-rh="true" property="og:locale:alternate" content="pt"><meta data-rh="true" property="og:locale:alternate" content="ru"><meta data-rh="true" property="og:locale:alternate" content="sv"><meta data-rh="true" property="og:locale:alternate" content="ta"><meta data-rh="true" property="og:locale:alternate" content="uk"><meta data-rh="true" property="og:locale:alternate" content="vi"><meta data-rh="true" property="og:locale:alternate" content="zh"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="twitter:card" content="summary"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Getting Started | WebdriverIO"><meta data-rh="true" name="description" content="Welcome to the WebdriverIO documentation. It will help you to get started fast. If you run into problems, you can find help and answers on our Discord Support Server or you can hit us on ð."><meta data-rh="true" property="og:description" content="Welcome to the WebdriverIO documentation. It will help you to get started fast. If you run into problems, you can find help and answers on our Discord Support Server or you can hit us on ð."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://webdriver.io/docs/gettingstarted"><link data-rh="true" rel="alternate" href="https://webdriver.io/docs/gettingstarted" hreflang="en"><link data-rh="true" rel="alternate" href="https://webdriver.io/ar/docs/gettingstarted" hreflang="ar"><link data-rh="true" rel="alternate" href="https://webdriver.io/de/docs/gettingstarted" hreflang="de"><link data-rh="true" rel="alternate" href="https://webdriver.io/es/docs/gettingstarted" hreflang="es"><link data-rh="true" rel="alternate" href="https://webdriver.io/fr/docs/gettingstarted" hreflang="fr"><link data-rh="true" rel="alternate" href="https://webdriver.io/hi/docs/gettingstarted" hreflang="hi"><link data-rh="true" rel="alternate" href="https://webdriver.io/it/docs/gettingstarted" hreflang="it"><link data-rh="true" rel="alternate" href="https://webdriver.io/ko/docs/gettingstarted" hreflang="ko"><link data-rh="true" rel="alternate" href="https://webdriver.io/pl/docs/gettingstarted" hreflang="pl"><link data-rh="true" rel="alternate" href="https://webdriver.io/pt/docs/gettingstarted" hreflang="pt"><link data-rh="true" rel="alternate" href="https://webdriver.io/ru/docs/gettingstarted" hreflang="ru"><link data-rh="true" rel="alternate" href="https://webdriver.io/sv/docs/gettingstarted" hreflang="sv"><link data-rh="true" rel="alternate" href="https://webdriver.io/ta/docs/gettingstarted" hreflang="ta"><link data-rh="true" rel="alternate" href="https://webdriver.io/uk/docs/gettingstarted" hreflang="uk"><link data-rh="true" rel="alternate" href="https://webdriver.io/vi/docs/gettingstarted" hreflang="vi"><link data-rh="true" rel="alternate" href="https://webdriver.io/zh/docs/gettingstarted" hreflang="zh"><link data-rh="true" rel="alternate" href="https://webdriver.io/docs/gettingstarted" hreflang="x-default">
6<link data-rh="true" rel="preconnect" href="https://3G5CUKDJDE-dsn.algolia.net" crossorigin="anonymous">
6<script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Getting Started","item":"https://webdriver.io/docs/gettingstarted"}]}</script>
6<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="WebdriverIO RSS Feed"> 7<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="WebdriverIO Atom Feed"> 8 9<link rel="preconnect" href="https://www.google-analytics.com">
10<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-47063382-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview")</script>
vendor: 1 bytes, line 10
10
11<script async src="https://www.google-analytics.com/analytics.js"></script>
11 12 13 14 15<link rel="search" type="application/opensearchdescription+xml" title="WebdriverIO" href="/opensearch.xml"> 16 17 18 19<link rel="icon" href="/img/logo-webdriver-io.png"> 20<link rel="manifest" href="/manifest.json"> 21<meta name="theme-color" content="rgb(234, 90, 7)"> 22<meta name="apple-mobile-web-app-capable" content="yes"> 23<meta name="apple-mobile-web-app-status-bar-style" content="#000"> 24<link rel="apple-touch-icon" href="/img/logo-webdriver-io.png"> 25<link rel="mask-icon" href="/img/logo-webdriver-io.svg" color="rgb(234, 90, 7)"> 26<meta name="msapplication-TileImage" content="/img/logo-webdriver-io.png"> 27<meta name="msapplication-TileColor" content="#000"> 28 29 30 31<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;700&display=block"> 32<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;700&display=block">
33<script src="https://buttons.github.io/buttons.js"></script>
vendor: 1 bytes, line 33
33
34<script src="/js/ribbons.js"></script>
34<link rel="stylesheet" href="/assets/css/styles.e1927623.css">
35<script src="/assets/js/runtime~main.1cf33942.js" defer="defer"></script>
vendor: 1 bytes, line 35
35
36<script src="/assets/js/main.748f0387.js" defer="defer"></script>
36 37</head> 38<body class="navigation-with-keyboard"> 39<svg style="display: none;"><defs> 40<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol> 41</defs></svg>
42<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script>
42<div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_rrU8" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_zxs0" role="banner"><div class="announcementBarPlaceholder_szcJ"></div><div class="content_VPCh announcementBarContent_NGMT">ðºð¦ We stand with the people of Ukraine. We encourage compassion, and hope for peace. ðºð¦<br>Please support humanitarian efforts for the Ukraine crisis through the <a target="_blank" rel="noopener noreferrer" href="https://www.icrc.org/en/donate/ukraine">International Committee of the Red Cross</a>! #StandWithUkraine</div><button type="button" aria-label="Close" class="clean-btn close closeButton_ixzz announcementBarClose_wYOc"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNjRweCIgaGVpZ2h0PSI2NHB4IiB2aWV3Qm94PSIwIDAgNjQgNjQiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI+CiAgICA8dGl0bGU+TG9nbyBSZWd1bGFyPC90aXRsZT4KICAgIDxnIGlkPSJMb2dvLVJlZ3VsYXIiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxyZWN0IGlkPSJSZWN0YW5nbGUiIGZpbGw9IiNFQTU5MDYiIHg9IjAiIHk9IjAiIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCIgcng9IjUiPjwvcmVjdD4KICAgICAgICA8cGF0aCBkPSJNOCwxNiBMOCw0OCBMNiw0OCBMNiwxNiBMOCwxNiBaIE00MywxNiBDNTEuODM2NTU2LDE2IDU5LDIzLjE2MzQ0NCA1OSwzMiBDNTksNDAuODM2NTU2IDUxLjgzNjU1Niw0OCA0Myw0OCBDMzQuMTYzNDQ0LDQ4IDI3LDQwLjgzNjU1NiAyNywzMiBDMjcsMjMuMTYzNDQ0IDM0LjE2MzQ0NCwxNiA0MywxNiBaIE0yNywxNiBMMTQuMTA2LDQ3Ljk5OTIwNzggTDExLjk5OSw0Ny45OTkyMDc4IEwyNC44OTQsMTYgTDI3LDE2IFogTTQzLDE4IEMzNS4yNjgwMTM1LDE4IDI5LDI0LjI2ODAxMzUgMjksMzIgQzI5LDM5LjczMTk4NjUgMzUuMjY4MDEzNSw0NiA0Myw0NiBDNTAuNzMxOTg2NSw0NiA1NywzOS43MzE5ODY1IDU3LDMyIEM1NywyNC4yNjgwMTM1IDUwLjczMTk4NjUsMTggNDMsMTggWiIgaWQ9IkNvbWJpbmVkLVNoYXBlIiBmaWxsPSIjRkZGRkZGIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==" alt="WebdriverIO" class="themedComponent_TDLl themedComponent--light_DFAV"><img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNjRweCIgaGVpZ2h0PSI2NHB4IiB2aWV3Qm94PSIwIDAgNjQgNjQiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI+CiAgICA8dGl0bGU+TG9nbyBSZWd1bGFyPC90aXRsZT4KICAgIDxnIGlkPSJMb2dvLVJlZ3VsYXIiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxyZWN0IGlkPSJSZWN0YW5nbGUiIGZpbGw9IiNFQTU5MDYiIHg9IjAiIHk9IjAiIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCIgcng9IjUiPjwvcmVjdD4KICAgICAgICA8cGF0aCBkPSJNOCwxNiBMOCw0OCBMNiw0OCBMNiwxNiBMOCwxNiBaIE00MywxNiBDNTEuODM2NTU2LDE2IDU5LDIzLjE2MzQ0NCA1OSwzMiBDNTksNDAuODM2NTU2IDUxLjgzNjU1Niw0OCA0Myw0OCBDMzQuMTYzNDQ0LDQ4IDI3LDQwLjgzNjU1NiAyNywzMiBDMjcsMjMuMTYzNDQ0IDM0LjE2MzQ0NCwxNiA0MywxNiBaIE0yNywxNiBMMTQuMTA2LDQ3Ljk5OTIwNzggTDExLjk5OSw0Ny45OTkyMDc4IEwyNC44OTQsMTYgTDI3LDE2IFogTTQzLDE4IEMzNS4yNjgwMTM1LDE4IDI5LDI0LjI2ODAxMzUgMjksMzIgQzI5LDM5LjczMTk4NjUgMzUuMjY4MDEzNSw0NiA0Myw0NiBDNTAuNzMxOTg2NSw0NiA1NywzOS43MzE5ODY1IDU3LDMyIEM1NywyNC4yNjgwMTM1IDUwLjczMTk4NjUsMTggNDMsMTggWiIgaWQ9IkNvbWJpbmVkLVNoYXBlIiBmaWxsPSIjRkZGRkZGIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==" alt="WebdriverIO" class="themedComponent_TDLl themedComponent--dark_kZl4"></div></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/gettingstarted">Docs</a><a class="navbar__item navbar__link" href="/docs/api">API</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/docs/contribute">
42Contribute</a><a class="navbar__item navbar__link" href="/community/support">Community</a><a class="navbar__item navbar__link" href="/docs/sponsor">Sponsor</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">v9</a><ul class="dropdown__menu"><li><a href="https://webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v9<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://v8.webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v8<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://v7.webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v7<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://v6.webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v6<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://v5.webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v5<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="http://v4.webdriver.io" target="_blank" rel="noopener noreferrer" class="dropdown__link dropdown-version-item">v4<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_YExK"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/ar/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="ar">اÙعربÙØ©</a></li><li><a href="/de/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="de">Deutsch</a></li><li><a href="/es/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="es">Español</a></li><li><a href="/fr/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="fr">Français</a></li><li><a href="/hi/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="hi">हिनà¥à¤¦à¥</a></li><li><a href="/it/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="it">Italiano</a></li><li><a href="/ko/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="ko">íêµì´</a></li><li><a href="/pl/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="pl">Polski</a></li><li><a href="/pt/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="pt">Português</a></li><li><a href="/ru/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="ru">Ð ÑÑÑкий</a></li><li><a href="/sv/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="sv">Svenska</a></li><li><a href="/ta/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="ta">தமிழà¯</a></li><li><a href="/uk/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="uk">УкÑаÑнÑÑка</a></li><li><a href="/vi/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="vi">Tiếng Viá»t</a></li><li><a href="/zh/docs/gettingstarted" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">ä¸æ</a></li><li class=""><hr style="margin: 0.3rem 0;"></li><li><a href="https://github.com/webdriverio/i18n#supported-languages" target="_blank" rel="noopener noreferrer" class="dropdown__link">Add your language<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><a href="https://github.com/webdriverio/webdriverio" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><a href="https://x.com/webdriverio" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-twitter-link" aria-label="@webdriverio on ð"></a><a href="https://youtube.com/@webdriverio" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-youtube-link" aria-label="@webdriverio on YouTube"></a><a href="https://discord.webdriver.io/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-discord-link" aria-label="Support Chat on Discord"></a><div class="toggle_DMK0 colorModeToggle_EmEJ"><button class="clean-btn toggleButton_cgGF toggleButtonDisabled_BMh6" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_dK3j lightToggleIcon_oXDl">
42<path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_dK3j darkToggleIcon_TPJS"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_dK3j systemToggleIcon_m8Yx"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Ram2"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_qsob"><div class="docsWrapper_tZ24"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ioUu" type="button"></button><div class="docRoot_aP7m"><aside class="theme-doc-sidebar-container docSidebarContainer_hWoP"><div class="sidebarViewport_DAlU"><div class="sidebar__Kyh"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_AC_x menuWithAnnouncementBar_qAfi"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--active" aria-current="page" href="/docs/gettingstarted"><span title="Getting Started" class="categoryLinkLabel_Lp4b">Getting Started</span></a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/why-webdriverio"><span title="Why Webdriver.IO?" class="linkLabel_QbzJ">Why Webdriver.IO?</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/boilerplates"><span title="Boilerplate Projects" class="linkLabel_QbzJ">Boilerplate Projects</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/setuptypes"><span title="Core Concepts" class="categoryLinkLabel_Lp4b">Core Concepts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/configuration"><span title="Configuration" class="categoryLinkLabel_Lp4b">Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/bestpractices"><span title="Guides" class="categoryLinkLabel_Lp4b">Guides</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/testrunner"><span title="Testrunner" class="categoryLinkLabel_Lp4b">
42Testrunner</span></a><button aria-label="Expand sidebar category 'Testrunner'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/devtools"><span title="DevTools" class="categoryLinkLabel_Lp4b">DevTools</span></a><button aria-label="Expand sidebar category 'DevTools'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/desktop-testing/macos"><span title="Desktop Testing" class="categoryLinkLabel_Lp4b">Desktop Testing</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/component-testing"><span title="Component Testing" class="categoryLinkLabel_Lp4b">Component Testing</span></a><button aria-label="Expand sidebar category 'Component Testing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/extension-testing/web-extensions"><span title="Extension Testing" class="categoryLinkLabel_Lp4b">Extension Testing</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/accessibility-testing/axe-core"><span title="Accessibility Testing" class="categoryLinkLabel_Lp4b">Accessibility Testing</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/ocr-testing/ocr-testing"><span title="OCR Testing" class="categoryLinkLabel_Lp4b">OCR Testing</span></a><button aria-label="Expand sidebar category 'OCR Testing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/visual-testing"><span title="Visual Testing" class="categoryLinkLabel_Lp4b">Visual Testing</span></a><button aria-label="Expand sidebar category 'Visual Testing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/flutter-testing/introduction"><span title="Flutter Testing" class="categoryLinkLabel_Lp4b">Flutter Testing</span></a><button aria-label="Expand sidebar category 'Flutter Testing'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist" href="/docs/mcp"><span title="MCP" class="categoryLinkLabel_Lp4b">MCP</span></a><button aria-label="Expand sidebar category 'MCP'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/v6-migration"><span title="Migrate" class="categoryLinkLabel_Lp4b">Migrate</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/cloudservices"><span title="Integration" class="categoryLinkLabel_Lp4b">Integration</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/allure-reporter"><span title="Reporter" class="categoryLinkLabel_Lp4b">Reporter</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_SWMM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/appium-service"><span title="Services" class="categoryLinkLabel_Lp4b">Services</span></a></div></li></ul></nav></div></div></aside><main class="docMainContainer_PL_x"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VYqs"><div class="docItemContainer_eX6x"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_q9hb" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon__nX2"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Getting Started</span></li></ul></nav><div class="tocCollapsible_MbWw theme-doc-toc-mobile tocMobile_lRJI"><button type="button" class="clean-btn tocCollapsibleButton_kL7n">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Getting Started</h1></header><p>Welcome to the WebdriverIO documentation. It will help you to get started fast. If you run into problems, you can find help and answers on our <a href="https://discord.webdriver.io" target="_blank" rel="noopener noreferrer" class="">Discord Support Server</a> or you can hit us on <a href="https://x.com/webdriverio" target="_blank" rel="noopener noreferrer" class="">ð</a>.</p> 43<div class="theme-admonition theme-admonition-info admonition_WfZ_ alert alert--info"><div class="admonitionHeading_qibW"><span class="admonitionIcon_nAYM"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_d0_1"><p>These are the docs for the latest version (<strong>>=9.x</strong>) of WebdriverIO. If you are still using an older version, please visit the <a class="" href="/versions">old documentation websites</a>!</p></div></div> 44<link rel="preload" href="https://i.ytimg.com/vi/rA4IFNyW54c/hqdefault.jpg" as="image"><article class="yt-lite" data-title="Getting Started with WebdriverIO" style="background-image:url(https://i.ytimg.com/vi/rA4IFNyW54c/hqdefault.jpg);--aspect-ratio:56.25%"><button type="button" class="lty-playbtn" aria-label="Watch Getting Started with WebdriverIO"></button></article> 45<div class="theme-admonition theme-admonition-tip admonition_WfZ_ alert alert--success"><div class="admonitionHeading_qibW"><span class="admonitionIcon_nAYM"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>Official YouTube Channel ð¥</div><div class="admonitionContent_d0_1"><p>You can find more videos around WebdriverIO on the <a href="https://youtube.com/@webdriverio" target="_blank" rel="noopener noreferrer" class="">official YouTube channel</a>. Make sure you subscribe!</p></div></div> 46<h2 class="anchor anchorTargetStickyNavbar_tva9" id="initiate-a-webdriverio-setup">Initiate a WebdriverIO Setup<a href="#initiate-a-webdriverio-setup" class="hash-l
46ink" aria-label="Direct link to Initiate a WebdriverIO Setup" title="Direct link to Initiate a WebdriverIO Setup" translate="no">â</a></h2> 47<p>To add a full WebdriverIO setup to an existing or new project using the <a href="https://www.npmjs.com/package/create-wdio" target="_blank" rel="noopener noreferrer" class="">WebdriverIO Starter Toolkit</a>, run:</p> 48<p>If you're in the root directory of an existing project, run:</p> 49<div class="theme-tabs-container tabs-container tabList_PGOh"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_Wr1C tabs__item--active">NPM</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">Yarn</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">pnpm</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">bun</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_l0gC"><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npm init wdio@latest .</span><br></span></code></pre></div></div><p>or if you want to create a new project:</p><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npm init wdio@latest ./path/to/new/project</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">yarn create wdio .</span><br></span></code></pre></div></div><p>or if you want to create a new project:</p><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">yarn create wdio ./path/to/new/project</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm create wdio@latest .</span><br></span></code></pre></div></div><p>or if you want to create a new project:</p><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm create wdio@latest ./path/to/new/project</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">bun create wdio@latest .</span><br></span></code></pre></div></div><p>or if you want to create a new project:</p><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">bun create wdio@latest ./path/to/new/project</span><br></span></code></pre></div></div></div></div></div> 50<p>This single command downloads the WebdriverIO CLI tool and runs a configuration wizard that helps you to configure your test suite.</p> 51<!-- --> 52<p>The wizard will prompt a set questions that guides you through the setup. You can pass a <code>--yes</code> parameter to pick a default set up which will use Mocha with Chrome using the <a href="https://martinfowler.com/bliki/PageOb
52ject.html" target="_blank" rel="noopener noreferrer" class="">Page Object</a> pattern.</p> 53<div class="theme-tabs-container tabs-container tabList_PGOh"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_Wr1C tabs__item--active">NPM</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">Yarn</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">pnpm</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_Wr1C">bun</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_l0gC"><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npm init wdio@latest . -- --yes</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">yarn create wdio . --yes</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm create wdio@latest . --yes</span><br></span></code></pre></div></div></div><div role="tabpanel" class="tabItem_l0gC" hidden=""><div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">bun create wdio@latest . --yes</span><br></span></code></pre></div></div></div></div></div> 54<h2 class="anchor anchorTargetStickyNavbar_tva9" id="install-cli-manually">Install CLI Manually<a href="#install-cli-manually" class="hash-link" aria-label="Direct link to Install CLI Manually" title="Direct link to Install CLI Manually" translate="no">â</a></h2> 55<p>You can also add the CLI package to your project manually via:</p> 56<div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npm i --save-dev @wdio/cli</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npx wdio --version # prints e.g. `8.13.10`</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># run configuration wizard</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npx wdio config</span><br></span></code></pre></div></div> 57<h2 class="anchor anchorTargetStickyNavbar_tva9" id="run-test">
57Run Test<a href="#run-test" class="hash-link" aria-label="Direct link to Run Test" title="Direct link to Run Test" translate="no">â</a></h2> 58<p>You can start your test suite by using the <code>run</code> command and pointing to the WebdriverIO config that you just created:</p> 59<div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npx wdio run ./wdio.conf.js</span><br></span></code></pre></div></div> 60<p>If you like to run specific test files you can add a <code>--spec</code> parameter:</p> 61<div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npx wdio run ./wdio.conf.js --spec example.e2e.js</span><br></span></code></pre></div></div> 62<p>or define suites in your config file and run just the test files defined by in a suite:</p> 63<div class="language-sh codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-sh codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">npx wdio run ./wdio.conf.js --suite exampleSuiteName</span><br></span></code></pre></div></div> 64<h2 class="anchor anchorTargetStickyNavbar_tva9" id="run-in-a-script">Run in a script<a href="#run-in-a-script" class="hash-link" aria-label="Direct link to Run in a script" title="Direct link to Run in a script" translate="no">â</a></h2> 65<p>If you would like to use WebdriverIO as an automation engine in <a class="" href="/docs/setuptypes#standalone-mode">Standalone Mode</a> within a Node.JS script you can also directly install WebdriverIO and use it as a package, e.g. to generate a screenshot of a website:</p> 66<div class="docusaurus-theme-github-codeblock"><div class="language-js codeBlockContainer_M1_4 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_B96F">getting-started/run-in-script.js</div><div class="codeBlockContent_y1ZH"><pre tabindex="0" class="prism-code language-js codeBlock_g5GX thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_dGz6"><span class="token-line" style="color:#393A34"><span class="token plain">loading</span><span class="token spread operator" style="color:#393A34">...</span><br></span></code></pre></div></div><div style="font-size:.9em;font-weight:600;color:#0E75DD;text-align:right;padding-bottom:13px;text-decoration:underline"><a href="https://github.com/webdriverio/example-recipes/blob/fc362f2f8dd823d294b9bb5f92bd5991339d4591/getting-started/run-in-script.js#L2-L19" class="githubLink" style="margin:0 10px" target="_blank">View on GitHub</a></div></div> 67<p><strong>Note:</strong> all WebdriverIO commands are asynchronous and need to be properly handled using <a href="https://javascript.info/async-await" target="_blank" rel="noopener noreferrer" class=""><code>async/await</code></a>.</p> 68<h2 class="anchor anchorTargetStickyNavbar_tva9" id="record-tests">Record tests<a href="#record-tests" class="hash-link" aria-label="Direct link to Record tests" title="Direct link to Record tests" translate="no">â</a></h2> 69<p>WebdriverIO provides tools to help you get started by recording your test actions on screen and generate WebdriverIO test scripts automatically. See <a class="" href="/docs/record">Recorder tests with Chrome DevTools Recorder</a> for more information.</p> 70<h2 class="anchor anchorTargetStickyNavbar_tva9" id="system-requirements">
70System Requirements<a href="#system-requirements" class="hash-link" aria-label="Direct link to System Requirements" title="Direct link to System Requirements" translate="no">â</a></h2> 71<p>Youâll need <a href="http://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> installed.</p> 72<ul> 73<li class="">Install at least v18.20.0 or higher as this is the oldest active LTS version</li> 74<li class="">Only releases that are or will become an LTS release are officially supported</li> 75</ul> 76<p>If Node is not currently installed on your system, we suggest utilizing a tool such as <a href="https://github.com/creationix/nvm" target="_blank" rel="noopener noreferrer" class="">NVM</a> or <a href="https://volta.sh/" target="_blank" rel="noopener noreferrer" class="">Volta</a> to assist in managing multiple active Node.js versions. NVM is a popular choice, while Volta is also a good alternative.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_MLUi"><a href="https://github.com/webdriverio/webdriverio/edit/main/website/docs/GettingStarted.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mtqG" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_lPmR"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/why-webdriverio"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Why Webdriver.IO?</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Hj2R thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#initiate-a-webdriverio-setup" class="table-of-contents__link toc-highlight">Initiate a WebdriverIO Setup</a></li><li><a href="#install-cli-manually" class="table-of-contents__link toc-highlight">Install CLI Manually</a></li><li>
76<a href="#run-test" class="table-of-contents__link toc-highlight">Run Test</a></li><li><a href="#run-in-a-script" class="table-of-contents__link toc-highlight">Run in a script</a></li><li><a href="#record-tests" class="table-of-contents__link toc-highlight">Record tests</a></li><li><a href="#system-requirements" class="table-of-contents__link toc-highlight">System Requirements</a></li></ul></div></div></div></div></main></div></div></div><div id="ms-floating-button" class="ms-fixed ms-bottom-4 ms-right-8 ms-z-[100] ms-flex ms-flex-col ms-items-end hover:ms-cursor-pointer"><div class="ms-relative ms-mb-4"><div style="background-color:#EA5906" class="ms-absolute -ms-bottom-1 ms-right-6 -ms-z-10 ms-h-4 ms-w-4 ms-rotate-45"></div><div style="background-color:#EA5906" class="ms-z-10 ms-flex ms-items-center ms-justify-center ms-rounded-lg ms-px-3 ms-py-2"><p style="color:#ffffff;margin:0" class="ms-text-sm">Welcome! How can I help?</p></div></div><div style="background-color:#EA5906" class="ms-flex ms-h-16 ms-w-16 ms-flex-col ms-items-center ms-justify-center ms-self-end ms-rounded-full ms-p-2 ms-transition"><div class="ms-rotate-0 ms-flex ms-h-full ms-w-full ms-transform ms-cursor-pointer ms-items-center ms-justify-center ms-rounded-full ms-transition-all ms-delay-75 ms-duration-100 ms-ease-in-out"><img src="/img/materials/robot-white.svg" alt="WebdriverIO AI Copilot" width="40px"></div></div><div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/gettingstarted">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api">API Reference</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/community/support">Help</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/webdriver-io" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://discord.webdriver.io" target="_blank" rel="noopener noreferrer" class="footer__link-item">Support Chat<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://seleniumhq.slack.com/join/shared_invite/zt-f7jwg1n7-RVw4v4sMA7Zjufira_~EVw#/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://x.com/webdriverio" target="_blank" rel="noopener noreferrer" class="footer__link-item">ð<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/sponsor">Sponsor</a></li><li class="footer__item"><a href="https://shop.webdriver.io" target="_blank" rel="noopener noreferrer" class="footer__link-item">Swag Store<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://youtube.com/@webdriverio" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_mZyn"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div>
76<div class="theme-layout-footer-column col footer__col"><div class="footer__title">Sponsored by</div><ul class="footer__items clean-list"><li class="footer__item"> 77 <a href="https://www.browserstack.com/automation-webdriverio" target="_blank" rel="noreferrer noopener" aria-label="Premium Sponsor BrowserStack"> 78 <img src="/img/sponsors/browserstack_white.svg" alt="BrowserStack"> 79 </a></li><li class="footer__item"> 80 <a href="https://momentic.ai/" target="_blank" rel="noreferrer noopener" aria-label="Premium Sponsor Momentic"> 81 <img src="/img/sponsors/momentic_white.svg" alt="Momentic"> 82 </a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://openjsf.org/" rel="noopener noreferrer" class="footerLogoLink_eTwg"><img src="https://raw.githubusercontent.com/openjs-foundation/artwork/main/openjs_foundation/openjs_foundation-logo-horizontal-color-dark_background.svg" alt="OpenJS Foundation Logo" class="footer__logo themedComponent_TDLl themedComponent--light_DFAV"><img src="https://raw.githubusercontent.com/openjs-foundation/artwork/main/openjs_foundation/openjs_foundation-logo-horizontal-color-dark_background.svg" alt="OpenJS Foundation Logo" class="footer__logo themedComponent_TDLl themedComponent--dark_kZl4"></a></div><div class="footer__copyright"> 83 <p> 84 Copyright 2026 <a href="https://openjsf.org">OpenJS Foundation</a> and WebdriverIO contributors. All rights reserved. The <a href="https://openjsf.org">OpenJS Foundation</a> has registered trademarks and uses trademarks. For a list of trademarks of the <a href="https://openjsf.org">OpenJS Foundation</a>, please see our <a href="https://trademark-policy.openjsf.org/">Trademark Policy</a> and <a href="https://trademark-list.openjsf.org/">Trademark List</a>. Trademarks and logos not indicated on the <a href="https://trademark-list.openjsf.org">list of OpenJS Foundation trademarks</a> are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them. 85 </p> 86 <p> 87 <a href="https://openjsf.org/">The OpenJS Foundation</a> | <a href="https://terms-of-use.openjsf.org/">Terms of Use</a> | <a href="https://privacy-policy.openjsf.org/">Privacy Policy</a> | <a href="https://bylaws.openjsf.org/">Bylaws</a> | <a href="https://code-of-conduct.openjsf.org/">Code of Conduct</a> | <a href="https://trademark-policy.openjsf.org/">Trademark Policy</a> | <a href="https://trademark-list.openjsf.org/">Trademark List</a> | <a href="https://www.linuxfoundation.org/cookies/">Cookie Policy</a> 88 </p> 89 </div></div></div></footer></div> 90</body> 91</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.