WebdriverIO Starter Toolkit
One command to create a fresh WebdriverIO project or add WebdriverIO to an existing project.
create-wdio
works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in our Gitter Support Chat.
Usage
To install a WebdriverIO project, you may choose one of the following methods:
npx
npx create-wdio@latest ./e2e
npx
is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions
npm
npm init wdio@latest ./e2e
npm init <initializer>
is available in npm 6+
yarn
yarn create wdio@latest ./e2e
yarn create <starter-kit-package>
is available in Yarn 0.25+
pnpm
pnpm create wdio ./e2e
pnpm create <starter-kit-package>
is available in pnpm v7+
It will create a directory called e2e
inside the current folder.
Then it will run the configuration wizard that will help you set-up your framework.
Supported Options
You can pass the following command line flags to modify the bootstrap mechanism:
--dev
- Install all packages as devDependencies
(default: true
)--yes
- Will fill in all config defaults without prompting (default: false
)--npm-tag
- use a specific NPM tag for @wdio/cli
package (default: latest
)
For more information on WebdriverIO see the homepage.