@wix-pilot/core/README.md

A flexible plugin that drives your tests with human-written commands, enhanced by the power of large language models (LLMs)

# @wix-pilot/core 🎯

> Core engine for Wix Pilot - Translating natural language into test actions

## Overview

The `@wix-pilot/core` package is the heart of Wix Pilot, responsible for:
- Orchestrating test execution
- Managing LLM interactions
- Providing the main API interface
- Handling driver registration and lifecycle
- Configurable logging system

## Installation

```bash
# npm
npm install --save-dev @wix-pilot/core

# yarn
yarn add -D @wix-pilot/core
```

## Pilot Usage

```typescript
import { pilot } from '@wix-pilot/core';
import { PuppeteerDriver } from '@wix-pilot/puppeteer';
import { CustomPromptHandler } from './custom-prompt-handler';

// Initialize Pilot with your preferred driver and a custom prompt handler
pilot.init({
  driver: new PuppeteerDriver(),
  promptHandler: new CustomPromptHandler(),
});

// Start a new Pilot flow
pilot.start();

// Run your automated flow
await pilot.perform(
  'Navigate to the homepage',
  'Click the login button',
  'The login form should be visible'
);

// End the flow
pilot.end();
```

## Autopilot Usage

Autopilot uses an agentic approach to perform goal-based automation flows.

```typescript
await pilot.autopilot('Register with a new account');
```

## Related Packages

- [@wix-pilot/puppeteer](../drivers/puppeteer) - Puppeteer driver for web testing
- [@wix-pilot/playwright](../drivers/playwright) - Playwright driver for modern web testing
- [@wix-pilot/detox](../drivers/detox) - Detox driver for React Native testing
- [@wix-pilot/appium](../drivers/appium) - Appium driver for mobile testing