npm init allwright: a test project in one command

Our TypeScript getting-started guide walks through six steps to go from an empty folder to a passing test: initialize the project, install @allwright.dev/vitest, write a tsconfig.json, write a vitest.config.ts, write the test, run it. Every step is correct and every step is boilerplate you shouldn't have to type by hand. As of create-allwright@0.0.60, you don't:

npm init allwright@latest

One command, and you have a working project — config, a starter test, and dependencies installed.

What it does

npm init allwright@latest (or npm create allwright@latest, same package) asks two questions and scaffolds a project from the answers:

• TypeScript or JavaScript.
• Which surfaces you want to test — Web, Mobile Android, or both.

From there it writes a small, real project, not a maze of generated files:

.
├── tests/
│   ├── web.spec.ts        # if Web is selected
│   └── mobile.spec.ts     # if Mobile Android is selected
├── allwright.config.yaml
├── vitest.config.ts
├── tsconfig.json          # TypeScript projects only
├── package.json
└── README.md

vitest.config.ts is already wrapped in allwrightVitestConfig, allwright.config.yaml is already pointed at the surfaces you picked, and each spec file is a real, runnable test against a public demo target — the same themoderninternet site and Airticket demo app used throughout our other guides — so npm test passes immediately, before you've changed a single line.

Then it detects your package manager — from an existing lockfile if you have one (bun.lock, pnpm-lock.yaml, yarn.lock, package-lock.json), falling back to whichever manager invoked the initializer — and runs the install for you. By the time the command finishes, node_modules is already there.

Non-interactive use

Every prompt has a flag, so CI, scripts, and anyone who'd rather not answer questions can skip the interactive session entirely:

npm init allwright@latest my-app -- --typescript --web --no-install

A target directory is the one positional argument — omit it to scaffold into the current folder.

Try it

npm init allwright@latest my-app
cd my-app
npm test

That's the same passing test the six-step manual walkthrough in our getting-started guide ends on, minus every step in between. The manual guide is still the right read if you want to understand what each generated file is actually doing, or you're wiring allwright into an existing project instead of starting a new one — the initializer is for the blank-folder case specifically.

Where to go next

• Run npm init allwright@latest and see what lands in a real folder.
• Read the create-allwright README for the full flag reference.
• Prefer to build it up file by file? The TypeScript getting-started guide is the same project, one step at a time.
• Selected Mobile Android? Jump straight to the Android testing walkthrough for what androidApp can do.
• Check the Changelog for everything else that's shipped since the last post.