Skip to main content

Start a Paxter project

Create and enter a new working folder, then initialise Paxter:

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

init is a free command. It creates these files in the current directory:

FilePurpose
paxter.yamlLocal configuration with empty registration fields.
workflow.yamlA minimal workflow with a safe placeholder URL.
.gitignoreEntries that protect local configuration and generated Paxter output.

Paxter never overwrites an existing file. When a file already exists, init leaves it unchanged and reports that decision.

Next steps

  1. Run paxter setup to install Paxter's supported Chromium browser.
  2. Request the licensed email and registration code from your organisation's Paxter administrator, or Booolean support for a direct purchase. Keep the issued values in paxter.yaml and outside source control.
  3. Read the configuration reference before changing output, temporary, browser, or parallel-run settings.
  4. Replace the placeholder URL in workflow.yaml with an approved non-production test environment.
  5. Validate access with paxter register.
  6. Run the workflow with paxter run workflow.yaml.

Safety

The generated workflow does not target a live website. Do not replace its placeholder with a production or third-party URL unless you have explicit written authorisation and have accepted the operational risk.