Commands
- Runs
- Attempts
- Jobs
- Job Runs
- Project
Runs List
List runs for a project.Project name. See Project Name Resolution.
Maximum number of results to return.
Number of results to skip (for pagination).
Filter results by field. Can be specified multiple times. Supported fields:
status, api_name, id, run_duration, started_at, run_type, job_id, job_run_id.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Runs Get
Get detailed information about a run.The ID of the run to retrieve.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Runs Start
Start a new Run.Run configuration. Accepts a JSON string or a path to a JSON file.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Attempts Get
Get detailed information about a specific Attempt.The ID of the Run containing the Attempt.
The attempt number to retrieve. If omitted, an interactive prompt is shown to select from available attempts.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Attempts Log
Download automation logs for a specific Attempt.The ID of the Run containing the Attempt.
The attempt number to download logs for. If omitted, an interactive prompt is shown.
Project name. See Project Name Resolution.
Output file path. Defaults to
log_<run-id>_<attempt-number>.jsonl.-h, --help
Display help for command. Will not execute the command.
Attempts Trace
Download a Playwright trace for a specific Attempt.The ID of the Run containing the Attempt.
The attempt number to download the trace for. If omitted, an interactive prompt is shown.
Project name. See Project Name Resolution.
Output file path. Defaults to
trace_<run-id>_<attempt-number>.zip.-h, --help
Display help for command. Will not execute the command.
Jobs List
List Jobs for a project.Project name. See Project Name Resolution.
Maximum number of results to return.
Number of results to skip (for pagination).
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Jobs Get
Get detailed information about a Job.The ID of the Job to retrieve.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Jobs Create
Create a new Job.Job configuration. Accepts a JSON string or a path to a JSON file.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Jobs Trigger
Manually trigger a Job run.The ID of the job to trigger.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
JobRuns List
List JobRuns for a specific job.The ID of the Job to list runs for.
Project name. See Project Name Resolution.
Maximum number of results to return.
Number of results to skip (for pagination).
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
JobRuns Get
Get detailed information about a JobRun.The ID of the Job.
The ID of the JobRun to retrieve.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Project Get
Get detailed information about the current project.Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Project Name Resolution
Commands that operate on a project resolve the project name in this order:--project-name flag > projectName field in settings file > Error
Reference
- Overview
- Dev reference — Develop and test automations locally.