https://github.com/webdriverio/create-wdio

One-line installer for WebdriverIO
https://github.com/webdriverio/create-wdio

cli e2e wdio webdriverio wizard

Last synced: 2 months ago
JSON representation

One-line installer for WebdriverIO

• Host: GitHub
• URL: https://github.com/webdriverio/create-wdio
• Owner: webdriverio
• License: mit
• Created: 2021-07-29T08:34:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T12:12:21.000Z (10 months ago)
• Last Synced: 2024-04-14T07:11:15.469Z (9 months ago)
• Topics: cli, e2e, wdio, webdriverio, wizard
• Language: TypeScript
• Homepage: https://webdriver.io
• Size: 6.69 MB
• Stars: 21
• Watchers: 6
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
WebdriverIO Starter Toolkit [![Test Changes](https://github.com/webdriverio/create-wdio/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/webdriverio/create-wdio/actions/workflows/test.yml) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/webdriverio/create-wdio/blob/main/CONTRIBUTING.md)

===========================



One command to create a fresh WebdriverIO project or add WebdriverIO to an existing project.

- [Get Started Guide](https://webdriver.io/docs/gettingstarted) - How to get started with WebdriverIO

- [Supported Options](#supported-options) - command line parameters

`create-wdio` works on macOS, Windows, and Linux.


If something doesn’t work, please [file an issue](https://github.com/webdriverio/create-wdio/issues/new).


If you have questions or need help, please ask in our [Discord Support channel](https://discord.webdriver.io).



    



## Usage

To install a WebdriverIO project, you may choose one of the following methods:

#### npx

```sh

npx create-wdio@latest ./e2e

```

_[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f)_

#### npm

```sh

npm init wdio@latest ./e2e

```

_[`npm init `](https://docs.npmjs.com/cli/v10/commands/npm-init) is available in npm 6+_

#### yarn

```sh

yarn create wdio@latest ./e2e

```

_[`yarn create `](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_

#### pnpm

```sh

pnpm create wdio ./e2e

```

_[`pnpm create `](https://pnpm.io/cli/create) 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](https://webdriver.io).