Metadata-Version: 2.4
Name: vibe-tester
Version: 0.1.0rc4
Summary: AI-driven UI automation testing framework with pluggable platform adapters.
Project-URL: Homepage, https://github.com/Haroldlei/vibe-tester
Project-URL: Repository, https://github.com/Haroldlei/vibe-tester
Project-URL: Issues, https://github.com/Haroldlei/vibe-tester/issues
Author: Vibe Testing Contributors
License: MIT
License-File: LICENSE
Keywords: agents,ai,bdd,behave,testing,uiautomation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Testing :: BDD
Requires-Python: >=3.11
Requires-Dist: behave>=1.2.6
Requires-Dist: jinja2>=3.1
Requires-Dist: pillow>=10.0
Requires-Dist: psutil>=5.9
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Requires-Dist: typer>=0.9.0
Provides-Extra: all
Requires-Dist: opencv-python>=4.8; extra == 'all'
Requires-Dist: playwright>=1.42; extra == 'all'
Requires-Dist: pyperclip>=1.8; extra == 'all'
Requires-Dist: pywinauto>=0.6.8; extra == 'all'
Requires-Dist: scikit-image>=0.21; extra == 'all'
Requires-Dist: uiautomation>=2.0.20; extra == 'all'
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: macos
Provides-Extra: web
Requires-Dist: playwright>=1.42; extra == 'web'
Provides-Extra: windows-desktop
Requires-Dist: opencv-python>=4.8; extra == 'windows-desktop'
Requires-Dist: pyperclip>=1.8; extra == 'windows-desktop'
Requires-Dist: pywinauto>=0.6.8; extra == 'windows-desktop'
Requires-Dist: scikit-image>=0.21; extra == 'windows-desktop'
Requires-Dist: uiautomation>=2.0.20; extra == 'windows-desktop'
Description-Content-Type: text/markdown

# vibe-tester

> AI-driven UI automation testing for desktop and web apps —
> Cucumber-style tests, pluggable platform adapters, ships with the AI
> assets your coding agent needs to author and run them.

**Status:** alpha. Public API may change. The `windows-desktop` and
`web` adapters are implemented; the `macos` adapter is a stub.

---

## What it does

1. Lets you describe a UI test in **natural language** (in Copilot
   Chat, Claude CLI, Cursor, …) and generates a runnable Gherkin
   `.feature` file using **real element locators** from your project's
   element store.
2. **Executes** scenarios at any granularity (one feature, all of
   them, or a tag expression) and produces a Markdown report
   plus optional JSON output for the AI to parse.
3. **Walks your app interactively** with you to record UI element
   paths into a YAML store the executor can resolve.

The framework ships **AI assets** (agents, skills, an `AGENTS.md`
template) and a deterministic **CLI** (`vibe-tester`). It does not
embed an LLM and does not run an MCP server — your AI tool of choice
provides the intelligence, the CLI is the integration surface.

---

## Docs

This README stays focused on getting started. Everything else —
architecture, how-tos, contributor rules, and the shipped-assets
catalog — is indexed from [doc/README.md](doc/README.md).

If you are editing shipped AI files, keep them role-pure: agents are
logic/process, skills are knowledge/reference, and assets are copied as
data.

---

## Install

```powershell
# default — every adapter that ships today
pip install vibe-tester

# pick one (smaller install)
pip install vibe-tester[windows-desktop]

# pick several
pip install vibe-tester[windows-desktop,web]
```

| Extra             | Drives                                              | Status      |
| ----------------- | --------------------------------------------------- | ----------- |
| `windows-desktop` | WinUI3 / Win32 / WPF / WebView2 / tray / shell menu | Implemented |
| `web`             | Browser SUTs (Playwright)                           | Implemented |
| `macos`           | macOS-native SUTs                                   | Stub        |

---

## Quickstart

```powershell
# 1. Create a fresh test project (or scaffold into an existing folder)
mkdir my-app-tests
cd my-app-tests
vibe-tester init

# 2. Capture your SUT (interactive — your app should be running)
vibe-tester collect

# 3. Ask your AI agent (Copilot Chat / Claude CLI / …) to write a test:
#    "Write a smoke test that opens Settings and verifies the title."

# 4. Run it
vibe-tester run
```

---

## CLI reference

| Command                                        | What it does                                                |
| ---------------------------------------------- | ----------------------------------------------------------- |
| `vibe-tester init [--target] [--adapter] [--overwrite] [--json]` | Scaffold a project from shipped assets        |
| `vibe-tester list adapters [--json]`          | Show installed adapters                                     |
| `vibe-tester list features [--json]`          | List `.feature` files                                       |
| `vibe-tester list elements [--details] [--json]` | Print the project's element vocabulary                  |
| `vibe-tester collect [--name] [--kind]`       | Interactive element capture                                 |
| `vibe-tester run [--feature\|--tag] [--scenario] [--json]` | Execute behave + emit Markdown / JSON report          |

All commands accept `--json` for machine-readable output (intended for
the AI agent to parse). Default output is human-friendly Rich tables
and Markdown reports under `./results/`.
