Quickstart
One command to a passing test.
npm init allwright@latest scaffolds a working TypeScript or JavaScript project — config, a starter test for the surfaces you pick, dependencies installed — instead of assembling one by hand.
$ npm init allwright@latest my-app
✔ TypeScript or JavaScript?
✔ Web, Mobile Android, or both?
✔ scaffolded, dependencies installed
$ cd my-app
$ npm test
✔ 1 passed
It asks two questions — language, and which surfaces to test — then writes a real, runnable project against the same public demo targets used throughout our guides, detects your package manager from an existing lockfile (or falls back to whichever manager invoked it), and installs for you. npm test passes immediately, before you change a line.
What lands in the folder
. |-- tests/ | |-- web.spec.ts | `-- mobile.spec.ts |-- allwright.config.yaml |-- vitest.config.ts |-- tsconfig.json |-- package.json `-- README.md
web.spec.ts and mobile.spec.ts are included based on which surfaces you pick; tsconfig.json only for TypeScript projects.
Scripting it, or wiring it into CI
Every prompt has a matching flag, so CI and scripts can skip the interactive session entirely.
| Flag | Does |
|---|---|
| --yes / -y | Accept defaults (TypeScript, Web) without prompting |
| --typescript / --javascript | Skip the language prompt |
| --web / --mobile / --both | Pick which surfaces to scaffold tests for |
| --package-manager <bun|npm|pnpm|yarn> | Override auto-detection |
| --no-install | Scaffold without installing dependencies |
Example: npm init allwright@latest my-app -- --typescript --web --no-install. See the create-allwright README for the full reference.
Prefer to build it up yourself?
The initializer is for the blank-folder case. If you're wiring allwright into an existing TypeScript or JavaScript project, our getting-started guide walks through the same project by hand — install @allwright.dev/vitest, write a config, write a test, run it — so you understand what each generated file is actually doing.
Testing Android? Jump to the Android testing walkthrough once you have a project scaffolded. Working in another language, allwright's client libraries are published and ready to install directly:
Try it now
Run the command, see what lands in a real folder, then check Availability for exactly what today's command set covers.