Configuration

Paxter reads paxter.yaml from the current working directory for commands that run workflows. This file controls the browser, where run evidence is stored, logging, parallel execution, and registration. It is the local settings file for one Paxter project; it is not the workflow itself.

Create the file and a safe example workflow with paxter init. Keep the generated configuration local: it can contain registration information and paths that only exist on your machine.

What you need to fill in

For a normal first run, fill in only the Registration values supplied by Booolean or your administrator. Leave ChromiumPath, OutputPath, and TempPath empty. Paxter then chooses safe per-user temporary locations automatically.

ChromiumPath: ""
OpenHtmlReportOnCompletion: false
OutputPath: ""
TempPath: ""
MaxParallelTests: 1
TestIterations: 1
Verbose: false
Registration:
  LicensedEmail: ""
  RegistrationCode: ""

After registration has been supplied, a practical first configuration looks like this:

# Leave blank to use Paxter's supported browser.
ChromiumPath: ""

# Leave both paths blank to use safe system temporary folders.
OutputPath: ""
TempPath: ""

OpenHtmlReportOnCompletion: false
MaxParallelTests: 1
TestIterations: 1
Verbose: false
Registration:
  LicensedEmail: "name@company.example"
  RegistrationCode: "registration-code-from-your-administrator"

Do not copy the sample email or registration code into a real file. They are examples only.

Setting	Default	Purpose
ChromiumPath	Empty	Optional path to a browser executable. Leave empty to use Paxter's supported Playwright Chromium build.
OpenHtmlReportOnCompletion	false	Opens the finished HTML report in the default browser. Keep it false in CI or unattended runs.
OutputPath	System temp Paxter-output folder	Parent folder for screenshots, HTML reports, and JSON output from a single run. Set an approved writable path if the default temporary location is unsuitable.
TempPath	System temp Paxter folder	Working area for command logs and parallel-run reports. Do not point it at source-control folders.
MaxParallelTests	1	Maximum simultaneous workflow instances. Values are clamped from 1 to 20; parallel runs require the subscription runparallel command.
TestIterations	1	Number of workflow repetitions. Values are clamped from 1 to 100; multiple iterations require runparallel.
Verbose	false	Emits additional progress messages and command logs. Enable temporarily while diagnosing a safe test run.
Registration	Empty	Local registration email and code required by registered and subscription commands.

Where Paxter stores run files

Paxter keeps run evidence and working files in different places. You may leave both settings empty, or set each to an approved writable directory that is outside your source repository.

Setting	What Paxter writes there	Default when blank	When to change it
OutputPath	One timestamped folder for each normal workflow run. Each folder contains index.html, output.json, screenshots, and, when enabled, video files.	The current user's system temporary folder under Paxter-output.	You need reports to persist after temporary files are cleaned, or your organisation requires evidence in an approved location.
TempPath	Verbose command logs and the aggregate reports produced by parallel runs.	The current user's system temporary folder under Paxter.	Your temporary directory is cleared too quickly, has insufficient space, or is not permitted for test data.

For example, to retain reports on a Windows test machine, use single-quoted paths so backslashes are treated literally by YAML:

OutputPath: 'D:\Paxter-data\output'
TempPath: 'D:\Paxter-data\temp'

Paxter creates missing output folders when it runs. The account running Paxter needs permission to create files in both locations. Do not use the project folder, a source-control folder, a shared public folder, or a location containing production data. Reports, screenshots, videos, and output.json can include page content and entered test values.

Which path should I choose?

• Personal local testing: leave both values blank.
• CI or a test runner: set both to writable directories created for that job, then collect or delete them according to your organisation's retention policy.
• Audited test evidence: set OutputPath to an approved protected location; leave TempPath separate and short-lived.
• Parallel subscription runs: provide adequate disk space in both locations. Every iteration creates its own evidence and the parallel summary is written under TempPath.

Other settings in plain language

OpenHtmlReportOnCompletion

Set this to true only when running Paxter interactively on your own desktop and you want the completed index.html report opened automatically. Leave it false for CI, scheduled jobs, remote runners, or unattended work; those environments cannot reliably open a browser window.

MaxParallelTests and TestIterations

Keep both at 1 for one ordinary, sequential run. TestIterations is how many times the same workflow is repeated; MaxParallelTests is the maximum number of repetitions that may run at once. For example:

MaxParallelTests: 3
TestIterations: 10

This requests ten workflow runs with no more than three running at the same time. Use it only with the subscription paxter runparallel command and only against a dedicated test environment that can safely handle the load. Paxter caps MaxParallelTests at 20 and TestIterations at 100.

Verbose

Set Verbose: true temporarily when investigating a safe test failure. It prints extra progress information and writes a command log under TempPath. Return it to false when you are finished, especially where command details or file paths should not be retained.

Registration

Enter the licensed email and registration code supplied for your organisation. Paxter cannot generate either value. Request them from your organisation's Paxter administrator, or, for a direct purchase, through Booolean support. If you do not know who administers the account, ask Booolean support for a contact without posting any secret values.

paxter register verifies the issued details before you run a registered workflow. These values are not workflow inputs; never add them to workflow.yaml, commit them, or paste them into tickets, logs, or screenshots. If account verification is unavailable, contact your Paxter administrator or Booolean support rather than trying to change hidden platform settings.

Chromium browser setup

Chromium is the open-source browser project that underpins Google Chrome and Microsoft Edge. Paxter drives a Playwright-managed Chromium build so browser behaviour is consistent with the version of Playwright bundled with Paxter. It does not require you to install Chrome separately.

After installing Paxter, install the supported browser for the current user:

paxter setup

Run paxter setup again after updating Paxter or when a browser launch reports that Chromium is unavailable. The command downloads browser files, so it needs network access and a writable per-user browser cache. Playwright keeps its browser binaries outside your Paxter workflow folder by default.

When to leave ChromiumPath empty

Leave it empty for almost every setup. This is the recommended configuration because Paxter and Playwright choose the matching Chromium build automatically:

ChromiumPath: ""

When to set ChromiumPath

Set ChromiumPath only when your organisation requires a specific browser executable, such as a centrally managed Chromium-based browser. Use the complete path to the executable and ensure the account that runs Paxter can read and execute it:

ChromiumPath: "C:\\Path\\To\\chromium.exe"

Using a custom browser can behave differently from Paxter's supported Playwright Chromium build. Test it in an approved non-production environment after browser updates. Do not put a browser path in a shared workflow if it is specific to one person's machine.

Security

Keep paxter.yaml untracked and use a secret manager or secure local environment for its registration values. Do not put real credentials in workflow YAML files, reports, or version control. Browser reports, screenshots, and video can contain test data, so store them only in approved locations.