Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 66 additions & 32 deletions docs/ai-agent.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,97 @@
---
description: Step-by-step guide to set up Wopee.io. Create a project, generate tests automatically, and run your first autonomous test in minutes.
description: Step-by-step guide to set up Wopee.io. Create a project, let the AI agent explore your app and generate tests, read the verdicts, and schedule your first test plan.
---

# 🤖 Getting started

## 1. Login to [Wopee Commander](https://cmd.wopee.io)
Your first AI test, from a URL to a verdict, in a few minutes. Prefer to watch first? Here is the 6-minute quick start:

<div style="width: 100%; aspect-ratio: 16 / 9; margin: 1rem 0 1.5rem; border-radius: 12px; overflow: hidden; background: #000;">
<iframe style="width: 100%; height: 100%; border: 0; display: block;" src="https://www.youtube.com/embed/o5ThjRddZfw" title="Wopee.io quick start: your first AI test in 6 minutes" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

## 1. Sign in to [Wopee Commander](https://cmd.wopee.io)

1. Go to [https://cmd.wopee.io](https://cmd.wopee.io).
2. Click on the `GitHub` or `GitLab` or `Google` login button.
3. Use your existing [GitHub](https://github.com/signup) or [GitLab](https://gitlab.com/users/sign_up) or [Google](https://accounts.google.com/) account and confirm the access.
2. Sign in with your [GitHub](https://github.com/signup), [GitLab](https://gitlab.com/users/sign_up) or [Google](https://accounts.google.com/) account.

You land on the **Projects** page. Every app you test lives here as one project.

## 2. Create a project and start the first Analysis

1. Click **NEW PROJECT**.
2. Paste the URL of your app, or pick a demo (**E-shop demo**, **Website demo** or **Banking demo**). The demos come with test instructions already filled in.
3. Under **Test instructions**, describe in plain English what matters to you, including any test credentials. For example: _Log in with the test account, add an item to the cart, complete the purchase, and verify the "Thank you" message._ You can leave it empty and let the agent decide.
4. Click **Create project and generate tests**.

![New project dialog](img/getting-started/2026-new-project.webp)

!!! tip "Advanced settings"

The test framework (Playwright) is fixed once the project exists. Switch off **Explore the app and generate tests** to create an empty project and add your own tests first.

![Login screen](img/getting-started/2024-08-08-15-10-15-image.png)
## 3. Accept the GitHub invitation

## 2. Create a project
Every project gets its own GitHub repository. To open it, accept the invitation: open the menu under your avatar, click **GH Invitation**, and click **Join** on GitHub.

1. Click the `NEW PROJECT` button in the top right corner.
2. Enter the URL of your app.
3. Confirm by clicking `CREATE`.
![GH Invitation in the account menu](img/getting-started/2026-gh-invitation.webp)

![Create new project](img/bot/2025-04-16_04-14.png)
## 4. Watch the agent explore

## 3. Get your tests
The first Analysis starts right away. You see a live view of the agent's browser: it opens your app, logs in, clicks through the pages and checks what it sees. From what it saw, it writes:

After creating a project, you have two options to add tests:
- an **application description**,
- **user flows**, written as user stories,
- **test scenarios** for those flows, and runs every one of them, so you start with real results.

**A. Generate new tests automatically**
All of them are under **Variables & Knowledge** and in the scenario list. Edit any of them, or add instructions and regenerate.

- Start a [NEW ANALYSIS](concepts/analysis-process.md) to let the system create tests for you.
- Learn about [🛠️ Tools & Assertions](concepts/tools-and-assertions.md) to understand how the agent interacts with your app.
- See [🩹 Self-Healing](concepts/self-healing.md) for how tests keep working when your UI changes.
## 5. Read the verdict

**B. Integrate your existing tests**
Click a scenario to open its run. The **Report** gives the verdict, every step with what was expected and what the agent verified, any issues it found, and a final analysis. When a test fails, read the report first: it tells you whether the app has a bug or the test needs a fix.

- Use your own test suites with one of the following frameworks:
![Scenario report](img/getting-started/2026-analysis-report.webp)

- [Playwright](playwright-visual-testing.md)
- [Cypress](cypress/01-getting-started.md)
- [Robot Framework](robot-framework/01-getting-started.md)
- [WebdriverIO](webdriverio-visual-testing.md)
Under **Steps**, every step has its Playwright locator and a screenshot. When your page changes, the agent can pick a better locator, so the test [heals itself](concepts/self-healing.md). The **Playwright report** shows exactly what ran.

## 4. Run tests
![Scenario steps with locators](img/getting-started/2026-analysis-steps.webp)

Once your tests are ready:
## 6. Your test library

1. Click the `START TESTING` button to begin running your tests.
**Scenarios** lists every test, grouped by Analysis and user story, with its category, number of steps and the agent's last verdict.

![Running tests](img/getting-started/2024-08-08-15-17-58-image.png)
![Scenarios library](img/getting-started/2026-scenarios.webp)

> **Note:** The `START TESTING` button may be disabled if tests are currently running.
To write your own test, click **+ New test**, give it a name and describe it in plain English. On its first run the agent works out the steps; keep **Save steps from this run** switched on, and later runs replay them.

## 5. Check the results
## 7. Test Plans and schedules

1. Visual difference is highlighted if it was identified comparing current state (on the left) and the baseline - previously approved state (on the right).
Group tests into a **Test Plan** (for example _Smoke Test_), run it by hand with **Run**, or put it on a schedule: every hour, day, week, month, or a custom cron expression.

![Comparison screen](img/getting-started/2024-08-08-15-23-56-image.png)
![Test plan with its run history](img/getting-started/2026-test-plan.webp)

## 6. Approve current state
## 8. Runs and visual checks

You can **👍 Approve** or **👎 Reject** current state of the tested application if [Test Step Status](glossary.md#test-step-status) is:
Every execution lands in **Runs**. Each step's screenshot is compared with its approved baseline, so you also see visual changes, not only broken clicks.

![Runs with the comparison view](img/getting-started/2026-runs.webp)

You can **👍 Approve** or **👎 Reject** the current state of the tested application if its [Test Step Status](glossary.md#test-step-status) is:

- `New` - no previous state was approved (for this test step)
- `Unresolved` - previous state was already approved but current state is different (for this test step)

## 9. Your tests in your repository

Each Analysis has its own branch in the project's GitHub repository: the user flows are a Markdown file, and the scenarios, with every step and Playwright locator, are a JSON file. Every change is a commit. Open the repository from **More** › **Repo**, or the whole project in VS Code or Cursor.

!!! note "Free plan and step limits"

The free plan gives the agent 50 steps every 5 hours and 2 projects. Every paid plan starts with the first month on us: see **Upgrade** in the app.

## More

- [🛠️ Tools & Assertions](concepts/tools-and-assertions.md): how the agent interacts with your app
- [🩹 Self-Healing](concepts/self-healing.md): how tests keep working when your UI changes
- Integrate your existing tests: [Playwright](playwright-visual-testing.md), [Cypress](cypress/01-getting-started.md), [Robot Framework](robot-framework/01-getting-started.md), [WebdriverIO](webdriverio-visual-testing.md)
- Short videos: [Wopee.io in 2 minutes](https://youtu.be/X4vKIrlauik), [Visual checks](https://youtu.be/jLA-rA1AHd0), [Your tests, your repo](https://youtu.be/7yLnLJBpBB4)
Binary file removed docs/img/bot/2025-04-16_04-14.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/getting-started/2026-new-project.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/getting-started/2026-runs.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/getting-started/2026-scenarios.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/getting-started/2026-test-plan.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,13 @@ The output is deterministic test code you can run anywhere. No LLMs or Wopee.io

We have also limited support for mobile apps, PDFs, desktop apps, and custom images generated or processed by your application. Contact us for more information.

## 🐒 Autonomous testing in a 2-minute video
## 🐒 Wopee.io in 2 minutes

<iframe width="560" height="315" src="https://www.youtube.com/embed/XNxoqs4l7vw?si=wycqaHZSprFjYB39" title="Introducing Wopee.io autonomous testing" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
<div style="width: 100%; aspect-ratio: 16 / 9; margin: 1rem 0 1.5rem; border-radius: 12px; overflow: hidden; background: #000;">
<iframe style="width: 100%; height: 100%; border: 0; display: block;" src="https://www.youtube.com/embed/X4vKIrlauik" title="Wopee.io in 2 minutes: an AI agent that tests your web app" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

Ready to try it? The [📙 Getting started](ai-agent.md) guide and its [6-minute quick start video](https://youtu.be/o5ThjRddZfw) walk you through every step.

## Start with bot testing : Step by step

Expand Down
Loading