|
1 | | -WebdriverIO Starter Toolkit [](https://github.com/webdriverio/create-wdio/actions/workflows/test.yml) [](https://github.com/webdriverio/create-wdio/blob/main/CONTRIBUTING.md) |
2 | | -=========================== |
3 | | - |
4 | | -<img alt="Logo" align="right" src="https://webdriver.io/assets/images/robot-3677788dd63849c56aa5cb3f332b12d5.svg" width="20%" /> |
5 | | - |
6 | | -One command to create a fresh WebdriverIO project or add WebdriverIO to an existing project. |
7 | | - |
8 | | -- [Get Started Guide](https://webdriver.io/docs/gettingstarted) - How to get started with WebdriverIO |
9 | | -- [Supported Options](#supported-options) - command line parameters |
10 | | - |
11 | | -`create-wdio` works on macOS, Windows, and Linux.<br> |
12 | | -If something doesn’t work, please [file an issue](https://github.com/webdriverio/create-wdio/issues/new).<br> |
13 | | -If you have questions or need help, please ask in our [Discord Support channel](https://discord.webdriver.io). |
14 | | - |
15 | | -<p align="center"> |
16 | | - <img src="https://raw.githubusercontent.com/webdriverio/wdio/main/.github/assets/demo.gif" alt="Example" /> |
17 | | -</p> |
18 | | - |
19 | | -## Usage |
20 | | - |
21 | | -To install a WebdriverIO project, you may choose one of the following methods: |
22 | | - |
23 | | -#### npx |
24 | | - |
25 | | -```sh |
26 | | -npx create-wdio@latest ./e2e |
27 | | -``` |
28 | | - |
29 | | -_[`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)_ |
30 | | - |
31 | | -#### npm |
32 | | - |
33 | | -```sh |
34 | | -npm init wdio@latest ./e2e |
35 | | -``` |
36 | | - |
37 | | -_[`npm init <initializer>`](https://docs.npmjs.com/cli/v10/commands/npm-init) is available in npm 6+_ |
38 | | - |
39 | | -#### yarn |
40 | | - |
41 | | -```sh |
42 | | -yarn create wdio@latest ./e2e |
43 | | -``` |
44 | | - |
45 | | -_[`yarn create <starter-kit-package>`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_ |
46 | | - |
47 | | -#### pnpm |
48 | | - |
49 | | -```sh |
50 | | -pnpm create wdio ./e2e |
51 | | -``` |
52 | | - |
53 | | -_[`pnpm create <starter-kit-package>`](https://pnpm.io/cli/create) is available in pnpm v7+_ |
54 | | - |
55 | | -It will create a directory called `e2e` inside the current folder. |
56 | | -Then it will run the configuration wizard that will help you set-up your framework. |
57 | | - |
58 | | - |
59 | | -## Supported Options |
60 | | - |
61 | | -You can pass the following command line flags to modify the bootstrap mechanism: |
62 | | - |
63 | | -* `--dev` - Install all packages as `devDependencies` (default: `true`) |
64 | | -* `--yes` - Will fill in all config defaults without prompting (default: `false`) |
65 | | -* `--npm-tag` - use a specific NPM tag for `@wdio/cli` package (default: `latest`) |
66 | | - |
67 | | ----- |
68 | | - |
69 | | -For more information on WebdriverIO see the [homepage](https://webdriver.io). |
| 1 | +This project has moved to: https://github.com/webdriverio/webdriverio/tree/main/packages/create-wdio |
0 commit comments