Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 38 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,47 @@
# Create Mobilewright
# create-mobilewright

Getting started with Mobilewright with a single "npm init" command
Scaffold a [Mobilewright](https://mobilewright.dev) test project in seconds.

## Usage

```sh
npm init mobilewright
# Or for Yarn
yarn create mobilewright
# Or for pnpm
pnpm create mobilewright
```

Follow the instructions on screen to create a scaffold Mobilewright test project:
Also works with Yarn (`yarn create mobilewright`) and pnpm (`pnpm create mobilewright`).

```text
mobilewright.config.ts
package.json
package-lock.json
tests/
example.spec.ts
```
The CLI walks you through setup and creates a ready-to-run project:

![create-mobilewright screenshot](docs/screenshot.png)

## What you get

```
my-project/
mobilewright.config.ts # Device and app configuration
tests/
example.spec.ts # A working test you can run immediately
package.json
```

## Run your first test

```sh
cd my-project
npx mobilewright test
```

That's it.

If this is the first time you are running a test on iOS (simulator or real device), you will need to run `npx mobilewright install` to set up the agent on the device.

If something's missing, `npx mobilewright doctor` tells you exactly what to fix.

## Next steps

- [Mobilewright docs](https://mobilewright.dev/docs) — API reference and guides
- [mobile-use.com](https://mobile-use.com) — Run tests on real devices in the cloud

## License

Apache
Loading