Commands
- Runs
- Attempts
- Auth Sessions
- Jobs
- Job Runs
- Issues
- Environment Variables
- Workspace Environment Variables
- 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.
Auth Sessions List
List auth sessions 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.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Auth Sessions Get
Get detailed information about an auth session.The ID of the auth session to retrieve.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Auth Sessions Create
Create a new auth session.The ID for the new auth session.
Project name. See Project Name Resolution.
Credentials parameters as a JSON string or a path to a JSON file (prefixed with
@).Proxy URL to use for the auth session creation.
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Auth Sessions Update
Update an existing auth session.The ID of the auth session to update.
Project name. See Project Name Resolution.
Credentials parameters as a JSON string or a path to a JSON file (prefixed with
@).Proxy URL to use for the auth session update.
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Auth Sessions Validate
Validate an existing auth session.The ID of the auth session to validate.
Project name. See Project Name Resolution.
Timeout in seconds for the validation operation.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Auth Sessions Delete
Delete an auth session.The ID of the auth session to delete.
Project name. See Project Name Resolution.
Output as JSON.
-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.
Issues List
List issues 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.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Issues Get
Get detailed information about an issue.The issue reference number.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Env Vars List
List environment variables 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.
Env Vars Get
Get details of an environment variable by key.The environment variable key.
Project name. See Project Name Resolution.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Env Vars Create
Create a new environment variable.Project name. See Project Name Resolution.
Variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Variable value. Must be 1–1000 characters.
Variable description. Up to 1000 characters.
Comma-separated environments. Supported values:
AUTHORING, PUBLISHED.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Env Vars Update
Update an existing environment variable by key.The current key of the environment variable to update.
Project name. See Project Name Resolution.
Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Updated variable value. Must be 1–1000 characters.
Updated variable description. Up to 1000 characters.
Updated comma-separated environments. Supported values:
AUTHORING, PUBLISHED.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Env Vars Delete
Delete an environment variable by key.The environment variable key to delete.
Project name. See Project Name Resolution.
Skip the confirmation prompt.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Workspace Env Vars List
List workspace-level environment variables.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.
Workspace Env Vars Get
Get details of a workspace environment variable by key.The environment variable key.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Workspace Env Vars Create
Create a new workspace-level environment variable.Variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Variable value. Must be 1–1000 characters.
Variable description. Up to 1000 characters.
Comma-separated environments. Supported values:
AUTHORING, PUBLISHED.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Workspace Env Vars Update
Update an existing workspace environment variable by key.The current key of the environment variable to update.
Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Updated variable value. Must be 1–1000 characters.
Updated variable description. Up to 1000 characters.
Updated comma-separated environments. Supported values:
AUTHORING, PUBLISHED.Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Workspace Env Vars Delete
Delete a workspace environment variable by key.The environment variable key to delete.
Skip the confirmation prompt.
Output as JSON.
-h, --help
Display help for command. Will not execute the command.
Project List
List all projects in the workspace.Maximum number of results to return.
Number of results to skip (for pagination).
Only show projects with AI enabled.
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.
- Configuration — Settings file, environment variables, and authentication.