paxter-cli
1.0.39
dotnet tool install --global paxter-cli --version 1.0.39
dotnet new tool-manifest
dotnet tool install --local paxter-cli --version 1.0.39
#tool dotnet:?package=paxter-cli&version=1.0.39
nuke :add-package paxter-cli --version 1.0.39
Paxter
Paxter turns readable YAML into browser workflows. Record a journey in a real browser, replay it any time, and keep the evidence — screenshots, video, and a step-by-step report — from a local Paxter Studio GUI or the command line.
Paxter ships as two .NET global tools:
| Tool | Install | What it is |
|---|---|---|
| paxter-gui | dotnet tool install --global paxter-gui |
The full Studio GUI in your browser: record, build, run, and review workflows. |
| paxter-cli | dotnet tool install --global paxter-cli |
The command-line runner for CI and scripts. |
Both need the .NET 10 runtime and run on Windows, macOS, and Linux. Each downloads its browser on the first setup.
Paxter Studio (GUI) — start in four steps
# 1. Install the tool globally (already installed? use: dotnet tool update --global paxter-gui)
dotnet tool install --global paxter-gui
# 2. Make a workspace and enter it
mkdir my-paxter-workflow && cd my-paxter-workflow
# 3. Install the browser used for recording and running (one time)
paxter-gui setup
# 4. Launch the Studio in your browser
paxter-gui
The Studio opens at http://localhost:6070. Workflows and recordings are saved in ./Outputs; run evidence (screenshots, video, reports) in ./.paxter-output. Keep the terminal open while using it; press Ctrl+C to stop.
- Record — open a site and click through it; every action becomes a reusable step.
- Builder — add, edit, drag, and reorder human-readable actions.
- Run — execute a workflow with live, plain-language progress and repair guidance.
- Evidence — review the screenshots and the video of each run.
paxter-gui init scaffolds a paxter.yaml and an example workflow in the current folder without overwriting existing files.
Paxter CLI — run workflows from the terminal
# 1. Install the tool globally
dotnet tool install --global paxter-cli
# 2. Create a project and install the browser
mkdir my-paxter-workflow && cd my-paxter-workflow
paxter init
paxter setup
# 3. Add your registration details to the local paxter.yaml and validate them
paxter register
# 4. Run a workflow
paxter run path/to/workflow.yaml
init creates a local paxter.yaml and an example workflow without overwriting existing files. Do not commit credentials or real workflow data.
Example workflow
Save this as example.yaml, then paxter run example.yaml (or open the Studio and press Run):
Headless: true
NeedVideo: false
Actions:
- Action: Page_GotoAsync
Data1: https://example.com
Other ways to run
Python Studio (wheel):
python -m pip install paxter_studio-*.whl, thenpaxter(needs Python 3.10+). See python/README.md.As a Python library:
from paxter_studio import run_workflow result = run_workflow("example.yaml", headless=True) print(result.session_path)Develop the Studio UI (Node):
cd ui && npm install && npm run dev— Vite serves the UI at http://localhost:6060 and proxies the local API on port 6061.
Safety
Only run workflows against sites and test environments you are authorised to use. YAML files, screenshots, videos, and reports may contain private data; store them in an approved location.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.