ChekovChekov

Documentation

Welcome to the Chekov documentation. Learn how to use Chekov to create AI-powered automated tests using natural language.

What is Chekov?

Chekov is an AI-powered testing solution that translates plain English prompts into Playwright test actions. Using Anthropic's Claude 3.5 Haiku model, Chekov interprets natural language instructions and converts them into precise browser automation commands.

Key Features

  • Natural Language Testing: Write tests in plain English instead of complex code
  • Playwright Integration: Seamlessly works with Playwright test runner
  • Parallel Execution: Run multiple commands in parallel for faster tests
  • Error Handling: Robust error handling and recovery mechanisms
  • API Access: RESTful API for custom integrations

Quick Links

Quick Start Guide

Get up and running with Chekov in minutes

API Reference

Detailed API documentation and examples

Usage Examples

Real-world examples and code samples

Best Practices

Learn how to write effective tests

Basic Example

Here's a simple example of how to use Chekov in your tests:

1
import { test } from '@playwright/test';
2
import { ai } from '@chekov/core';
3


4
test('user can log in', async ({ page }) => {
5
  await page.goto('https://example.com');
6
  
7
  await ai('Click the login button', { page });
8
  await ai('Type "testuser" in the username field', { page });
9
  await ai('Type "password123" in the password field', { page });
10
  await ai('Click Submit', { page });
11
  
12
  await ai('Verify the welcome message is visible', { page });
13
});

Getting Help

If you need help or have questions, you can: