Quickstart Guide

Run your first automated test in under 2 minutes.

Before you start: Make sure you have the necessary tools for your platform (browsers for Web, Android Studio for Android, Xcode for iOS). See Requirements for the full checklist.

---

1. Install the CLI

Install the zenitest command line tool globally:

npm

npm install -g zenitest

pnpm

pnpm add -g zenitest

yarn

yarn global add zenitest

bun

bun install -g zenitest

---

2. Install AI Agent Skill

Install the ZeniTest skill into your AI coding assistant (Claude Code, Cursor, Antigravity, Codex, etc.) so it can write and maintain tests for you:

npm

npx skills add zenitest-org/skills

pnpm

pnpm dlx skills add zenitest-org/skills

yarn

yarn dlx skills add zenitest-org/skills

bun

bunx skills add zenitest-org/skills

---

3. Log in with your API Key

Link your account using your API key:

zenitest auth <your_api_key>

---

4. Generate Test Cases

Ask your AI coding assistant to generate test cases for your app:

Generate test cases for our login flow

Generate test cases for the checkout workflow

Your AI assistant will create .yaml test files directly in your zenitests/ directory.

Example Generated Test (zenitests/web/tc_login.yaml)

id: tc_login
title: Login Test
expectedResult: User is logged in and sees the product inventory.

steps:
  - navigate: /
  - act: Type 'standard_user' into 'Username'
  - act: Type 'secret_sauce' into 'Password'
  - act: Click 'Login'
  - validate: Verify 'Products' page title is displayed

---

5. Run the Tests

Execute your test suite from your terminal:

Run all tests:

zenitest run

Run only web tests:

zenitest run --platform web

Run mobile tests:

zenitest run --platform android --bundle ./build/app-debug.apk