create-allwright
v0.2.0
Published
Create a new allwright test project with npm init allwright.
Maintainers
Readme
create-allwright
Create a new allwright test project with:
npm init allwright@latestOr:
npm create allwright@latestThe initializer prompts for:
TypeScriptorJavaScript- one or more surfaces such as
Web,Mobile Android,Mobile iOS,Desktop macOS, andDesktop Windows - an optional target directory
It scaffolds a Node project with package.json, Vitest config, shared allwright config, starter tests, and a short README for the generated app.
Select Mobile iOS interactively, or scaffold it non-interactively:
npm init allwright@latest ios-tests -- --yes --iosSelect Desktop macOS interactively, or scaffold a macosApp project
non-interactively:
npm init allwright@latest macos-tests -- --yes --macosSelect Desktop Windows interactively, or scaffold a windowsApp project
non-interactively:
npm init allwright@latest windows-tests -- --yes --windowsUse --all to scaffold Web, Mobile Android, Mobile iOS, Desktop macOS, and Desktop Windows
together. The repeatable --surface flag supports the ids web,
mobile-android, mobile-ios, desktop-mac, and desktop-windows for explicit combinations.
This writes an iosApp starter test and configures the public universal
Simulator IPA at https://allwright.dev/Flights-simulator.ipa. On the first
test run, core installs the mobile-ios plugin and its bundled headless XCTest
agent, then the fixture downloads and installs the sample app. Users do not
install either component manually.
The Desktop macOS starter configures the installed Calculator app and writes a
lazy macosApp screenshot test. Its first run installs desktop-mac, starts a
locally signed copy of the bundled XCUITest runner, and launches Calculator.
It requires macOS 14 or newer, Xcode, and UI Automation permission for the
process running Xcode.
The Desktop Windows starter configures Notepad and writes a lazy windowsApp
screenshot test. Its first run installs desktop-windows and starts the bundled,
self-contained FlaUI UIA3 agent. It requires an interactive Windows 10 or newer
desktop session; no separate Appium, WinAppDriver, or .NET installation is needed.
Dependencies are installed automatically with the package manager that ran the initializer. Existing lockfiles take precedence; use --package-manager npm|yarn|pnpm|bun to override detection, or --no-install to scaffold without installing.
