Commands

The current CLI accepts a full command name or the short alias shown below. The packaged tool command is paxter; when running from source, use dotnet run --project Paxter.CLI -- before the command.

Available commands

Command	Alias	What it does
version	-v	Prints the Paxter version.
help	-h	Lists the commands known to the CLI.
actions	-a	Lists every supported workflow action with its fields, plus the plain-English aliases and the target syntax.
init	-i	Creates safe starter files in the current directory without overwriting files.
setup	-s	Installs the Playwright-managed Chromium browser used by Paxter.
register	-k	Validates the configured Paxter registration.
validate workflow.yaml [--data file] [--rows 1-3]	-l	Checks a workflow and its data source without launching a browser and exits with code 1 on errors.
run [workflow.yaml] [--data file] [--rows 1-3]	-r	Runs up to 10 workflow actions with registration; larger workflows require a subscription. With a data source, runs once per row.
runparallel [workflow.yaml] [--data file] [--rows 1-3]	-p	Executes a paid parallel workflow using the configured parallel settings, or a data-driven suite with concurrent cases.
convert source.txt	-c	Subscription feature that converts supported Playwright code in a .txt file to YAML and writes a conversion log.
update	-u	Shows the global-tool update command.

help marks free commands with a space, registered commands with +, and paid commands with *. Every command returns exit code 0 on success and 1 when validation fails, a workflow or suite fails, or an error occurs.

Install the browser

paxter setup

This installs Paxter's supported Playwright Chromium build for the current user. Run it after installing or updating Paxter, and before the first browser workflow. See browser configuration for when to use ChromiumPath.

Version, help, and actions

paxter version
paxter help
paxter actions
paxter update

actions is the quickest reference while writing a workflow: it prints each action's category, required fields, and a one-line description, followed by the accepted plain-English aliases and a summary of the target syntax.

Register the installation

Registration is issued; it is not created by the register command or generated from the CLI. To obtain it:

1. If Paxter is provided by your organisation, ask your organisation's Paxter administrator for the licensed email and registration code assigned to you.
2. If you bought Paxter directly, request access through Booolean support.
3. If you do not have either contact, use Booolean support to request a contact. Do not include registration codes, credentials, tokens, workflow files, screenshots, or reports in a support request.

Add the issued details to an untracked local paxter.yaml, then validate the installation:

Registration:
  LicensedEmail: "your-issued-email@example.com"
  RegistrationCode: "your-issued-registration-code"

paxter register

run requires a verified registration and allows up to 10 workflow actions. When a workflow has more than 10 actions, Paxter checks for a current subscription before it runs. convert and runparallel require a current Paxter subscription; runparallel also requires either MaxParallelTests or TestIterations to be greater than 1, or a data-driven workflow.

Convert Playwright code

paxter convert path\to\recording.txt

The input must be a .txt file. Paxter writes recording.yaml and recording.log alongside it. The log identifies action lines that were not recognised by the converter. Converted workflows use the Playwright-style action names; you can keep them or replace them with the generic actions and targets described in Workflow actions.