Pomelo PW

English | 简体中文

Pomelo PW is a Playwright-powered CLI for browser automation. It runs declarative YAML flows, so browser checks can live alongside application code without requiring a custom test harness.

It is intended for repeatable UI checks, scripted workflows, visual comparisons, and agent-assisted browser tasks. Flows validate their parameters before execution and collect screenshots, page snapshots, console errors, and network failures when a step fails.

What It Provides

• YAML browser flows: navigation, forms, waits, screenshots, and login-state reuse
• Typed runtime data, DOM extraction, session HTTP requests, conditions, iteration, polling, and assertions
• Retries, data-driven runs, structured reports, and screenshot baseline comparison
• CLI, Python package integration, and native plugins for Claude Code, Codex, and Grok Build

Install

The Python package requires Python 3.12+. Install it with uv:

uv tool install pomelo-pw
pomelo-pw install

The package is available on PyPI. Standalone Windows, macOS, and Linux executables are available from GitHub Releases. See the usage guide for browser selection, optional dependencies, and package integration.

Quick Start

Create smoke.yaml:

name: example-smoke
variables:
  base_url: "https://the-internet.herokuapp.com"
steps:
  - type: navigate
    url: "{{base_url}}"
  - type: screenshot
    file: homepage.png

Validate and run:

pomelo-pw validate smoke.yaml
pomelo-pw run smoke.yaml --headless

Artifacts are written to smoke/ under the working directory by default. Use -o <directory> to override the output location or --var key=value to override flow variables.

Documentation

License

MIT