Commands
- Runs
- Attempts
- Auth Sessions
- Jobs
- Job Runs
- Issues
- Environment Variables
- Workspace Environment Variables
- Project
- Web Tasks
Runs List
List runs for a project.string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
string[]
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.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Runs Get
Get detailed information about a run.string
required
The ID of the run to retrieve.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Runs Start
Start a new Run.string
required
Run configuration. Accepts a JSON string or a path to a JSON file.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Attempts Get
Get detailed information about a specific Attempt.string
required
The ID of the Run containing the Attempt.
int
The attempt number to retrieve. If omitted, an interactive prompt is shown to select from available attempts.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Attempts Log
Download automation logs for a specific Attempt.string
required
The ID of the Run containing the Attempt.
int
The attempt number to download logs for. If omitted, an interactive prompt is shown.
string
Project name. See Project Name Resolution.
string
Output file path. Defaults to
log_<run-id>_<attempt-number>.jsonl.Display help for command. Will not execute the command.
Attempts Trace
Download a Playwright trace for a specific Attempt.string
required
The ID of the Run containing the Attempt.
int
The attempt number to download the trace for. If omitted, an interactive prompt is shown.
string
Project name. See Project Name Resolution.
string
Output file path. Defaults to
trace_<run-id>_<attempt-number>.zip.Display help for command. Will not execute the command.
Auth Sessions List
List auth sessions for a project.string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
string[]
Filter results by field. Can be specified multiple times.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Auth Sessions Get
Get detailed information about an auth session.string
required
The ID of the auth session to retrieve.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Auth Sessions Create
Create a new auth session.string
required
The ID for the new auth session.
string
Project name. See Project Name Resolution.
string
Credentials parameters as a JSON string or a path to a JSON file (prefixed with
@).string
Proxy URL to use for the auth session creation.
string
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Auth Sessions Update
Update an existing auth session.string
required
The ID of the auth session to update.
string
Project name. See Project Name Resolution.
string
Credentials parameters as a JSON string or a path to a JSON file (prefixed with
@).string
Proxy URL to use for the auth session update.
string
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Auth Sessions Validate
Validate an existing auth session.string
required
The ID of the auth session to validate.
string
Project name. See Project Name Resolution.
int
default:"300"
Timeout in seconds for the validation operation.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Auth Sessions Delete
Delete an auth session.string
required
The ID of the auth session to delete.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs List
List Jobs for a project.string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Get
Get detailed information about a Job.string
required
The ID of the Job to retrieve.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Create
Create a new Job.string
required
Job configuration. Accepts a JSON string or a path to a JSON file.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Update
Update an existing Job.string
required
The ID of the Job to update.
string
required
Updated Job configuration. Accepts a JSON string or a path to a JSON file.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Trigger
Manually trigger a Job run.string
required
The ID of the job to trigger.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Pause
Pause a Job. Scheduled runs stop until the Job is resumed.string
required
The ID of the Job to pause.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Resume
Resume a paused Job.string
required
The ID of the Job to resume.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Jobs Delete
Delete a Job. Asks for confirmation unless-y / --yes is passed.
string
required
The ID of the Job to delete.
string
Project name. See Project Name Resolution.
default:"false"
Skip the confirmation prompt.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
JobRuns List
List JobRuns for a specific job.string
required
The ID of the Job to list runs for.
string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
JobRuns Get
Get detailed information about a JobRun.string
required
The ID of the Job.
string
required
The ID of the JobRun to retrieve.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
JobRuns Terminate
Terminate a running JobRun. The CLI resolves the Job from the JobRun ID.string
required
The ID of the JobRun to terminate.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Issues List
List issues for a project.string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
string[]
Filter results by field. Can be specified multiple times.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Issues Get
Get detailed information about an issue.int
required
The issue reference number.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Env Vars List
List environment variables for a project.string
Project name. See Project Name Resolution.
int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Env Vars Get
Get details of an environment variable by key.string
required
The environment variable key.
string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Env Vars Create
Create a new environment variable.string
Project name. See Project Name Resolution.
string
required
Variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
string
required
Variable value. Must be 1–1000 characters.
string
Variable description. Up to 1000 characters.
string
default:"PUBLISHED"
Comma-separated environments. Supported values:
AUTHORING, PUBLISHED.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Env Vars Update
Update an existing environment variable by key.string
required
The current key of the environment variable to update.
string
Project name. See Project Name Resolution.
string
Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
string
Updated variable value. Must be 1–1000 characters.
string
Updated variable description. Up to 1000 characters.
string
Updated comma-separated environments. Supported values:
AUTHORING, PUBLISHED.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Env Vars Delete
Delete an environment variable by key.string
required
The environment variable key to delete.
string
Project name. See Project Name Resolution.
default:"false"
Skip the confirmation prompt.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Workspace Env Vars List
List workspace-level environment variables.int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Workspace Env Vars Get
Get details of a workspace environment variable by key.string
required
The environment variable key.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Workspace Env Vars Create
Create a new workspace-level environment variable.string
required
Variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
string
required
Variable value. Must be 1–1000 characters.
string
Variable description. Up to 1000 characters.
string
default:"PUBLISHED"
Comma-separated environments. Supported values:
AUTHORING, PUBLISHED.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Workspace Env Vars Update
Update an existing workspace environment variable by key.string
required
The current key of the environment variable to update.
string
Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
string
Updated variable value. Must be 1–1000 characters.
string
Updated variable description. Up to 1000 characters.
string
Updated comma-separated environments. Supported values:
AUTHORING, PUBLISHED.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Workspace Env Vars Delete
Delete a workspace environment variable by key.string
required
The environment variable key to delete.
default:"false"
Skip the confirmation prompt.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Project List
List all projects in the workspace.int
default:"50"
Maximum number of results to return.
int
default:"0"
Number of results to skip (for pagination).
default:"false"
Only show projects with AI enabled.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Project Get
Get detailed information about the current project.string
Project name. See Project Name Resolution.
default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Web Tasks Start
Start a new Web Task. Returns thewebTaskId immediately; use webtasks result to fetch the result.
string
required
Natural-language description of the task to run.
string
Optional hint telling the agent where to start in the browser.
string
Free-form parameters as a JSON string or a path to a JSON file.
string
Expected output JSON Schema as a JSON string or a path to a JSON file.
string
Reuse key for persisted task resources. If omitted, the server generates one and returns it in the result.
string
default:"haiku"
Model to use:
haiku, sonnet, or opus.default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Web Tasks Run
Start a Web Task and block until it reaches a terminal state (completed or canceled).
string
required
Natural-language description of the task to run.
string
Optional hint telling the agent where to start in the browser.
string
Free-form parameters as a JSON string or a path to a JSON file.
string
Expected output JSON Schema as a JSON string or a path to a JSON file.
string
Reuse key for persisted task resources. If omitted, the server generates one and returns it in the result.
string
default:"haiku"
Model to use:
haiku, sonnet, or opus.string
default:"10m"
Stop waiting after the given duration (for example,
30s, 10m, 2h).default:"false"
Output as JSON.
Display help for command. Will not execute the command.
Web Tasks Result
Fetch the current status and result of a Web Task.string
required
The ID returned when the task was started.
default:"false"
Output as JSON.
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.