Skip to main content

Welcome to Paxter

Paxter turns clear YAML workflow definitions into repeatable Playwright browser runs. It is designed for teams that want automation to stay readable, reviewable, and supported by visual evidence.

This documentation is kept current alongside the Paxter CLI.

What you can do​

  • Describe browser steps with a focused YAML action list.
  • Convert supported Playwright snippets into a workflow starting point.
  • Run workflows in headless or visible browser mode.
  • Capture screenshots at every step and optionally record video.
  • Review a shareable HTML report alongside JSON run data.

Start in four steps​

  1. Install or build the Paxter CLI.

    dotnet tool install --global paxter-cli

  2. Create a local project and install the supported browser:

    mkdir my-paxter-workflow
    cd my-paxter-workflow
    paxter init
    paxter setup

    init creates a local paxter.yaml configuration file and example workflow without overwriting existing files. Do not commit credentials or real workflow data.

  3. Add your registration details to the local paxter.yaml file and validate them:

    paxter register

  4. Create a workflow and run it.

    paxter run path\to\workflow.yaml

A minimal workflow​

Headless: true
NeedVideo: false
Actions:
  - Do: Page_GotoAsync
    Data1: https://your-test-environment.example

Continue with the command reference or learn how to configure Paxter.