Skip to main content
✨ Private beta

Welcome to the Taqwright beta

Thanks for helping us test Taqwright. You have early access to the private repo. In a few minutes you will install Taqwright from GitHub, scaffold a project, try the tools, and run mobile tests on your own machine.

Prerequisites

  • Node.js 24 or newer and npm.
  • git with an SSH key on your GitHub account. Taqwright installs over SSH from the private repo taqelah/taqwright, so SSH access is required.
  • A device target: an Android emulator or an iOS simulator. Taqwright can auto-install the Android toolchain for you. iOS needs macOS with Xcode.

Confirm your access

Accept the GitHub invitation to taqelah/taqwright, then confirm git can reach it over SSH. This should print a list of refs:

git ls-remote git@github.com:taqelah/taqwright.git

If it fails, add your SSH key to GitHub (Settings → SSH and GPG keys) and make sure you have accepted the repo invite.

Scaffold a project

Install the CLI from the repo, then scaffold a project. init writes a taqwright.config.ts, a sample test, wires the demo app, adds Taqwright as a git+ssh dependency, and runs npm install. It can also offer to install the Android toolchain and an emulator.

# install the taqwright CLI from the private repo (over SSH)
npm i -g git+ssh://git@github.com/taqelah/taqwright.git

# scaffold a project: config, a sample test, and the demo app
taqwright init my-mobile-tests
cd my-mobile-tests

Already have a project? Add Taqwright to it instead:

npm install git+ssh://git@github.com/taqelah/taqwright.git
npx taqwright init

Check your environment

Verify everything is wired up, and see what devices are available:

npx taqwright doctor        # verify your environment
npx taqwright devices       # list emulators / simulators / devices

On Android you can provision the full toolchain plus an emulator with npx taqwright install --with-avd.

Explore the tools

  • npx taqwright codegen opens an inspector and records a runnable test as you tap the app. See codegen →
  • npx taqwright inspect opens the same inspector to browse the live UI tree and build locators, without recording.
  • npx taqwright doctor and npx taqwright devices keep your setup healthy.

Run the tests

Run the sample suite on your device, then open the report:

npx taqwright test          # run the sample tests
npx taqwright show-report   # open the HTML report

Add --project android or --project ios to target one platform. See Running & debugging.

Learn more

Installation →Writing tests →Codegen →Command line →Configuration →Trace viewer →Sample repo ↗

Start from the sample project

Prefer a ready-made project? Clone the demo, install, and run it to see a passing suite right away.

git clone https://github.com/Taqwright/taqwright-demo.git
cd taqwright-demo
npm install        # pulls Taqwright over SSH (see Prerequisites)
npx taqwright test

npm install still fetches Taqwright over SSH from taqelah/taqwright, so make sure your SSH access works first (Prerequisites and Step 1). Browse the repo: https://github.com/Taqwright/taqwright-demo.