Commands
- Runs
- Attempts
- Auth Sessions
- Interactions
- Jobs
- Job Runs
- Issues
- Environment Variables
- Workspace Environment Variables
- Project
- Web Tasks
Runs List
List runs for a project.Project name. See Project Name Resolution.
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.Runs Get
Get detailed information about a run. While the Run waits onaskForInput or handoff, the output lists its pending interactions with the commands that answer them (Interactions Resolve, Interactions Cancel). With --json, they’re in pendingInteractions.
Project name. See Project Name Resolution.
Runs Start
Start a new Run. With--wait, while waiting, any askForInput or handoff interaction the Run starts is printed with the command that answers it. See Interactions Resolve.
Project name. See Project Name Resolution.
Runs Set Attributes
Replace the attributes of a finished Run. Keys left out are removed, and{} removes them all. See Run attributes.
Project name. See Project Name Resolution.
Attempts Get
Get detailed information about a specific Attempt.The attempt number to retrieve. If omitted, an interactive prompt is shown to select from available attempts.
Project name. See Project Name Resolution.
Attempts Log
Download automation logs for a specific Attempt.Project name. See Project Name Resolution.
Attempts Trace
Download a Playwright trace for a specific Attempt.Project name. See Project Name Resolution.
Auth Sessions List
List auth sessions for a project.Project name. See Project Name Resolution.
Auth Sessions Get
Get detailed information about an auth session.Project name. See Project Name Resolution.
Auth Sessions Create
Create a new auth session. While waiting, anyaskForInput or handoff interaction the operation starts is printed with the command that answers it. See Interactions Resolve.
Project name. See Project Name Resolution.
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.Auth Sessions Update
Update an existing auth session. While waiting, anyaskForInput or handoff interaction the operation starts is printed with the command that answers it. See Interactions Resolve.
Project name. See Project Name Resolution.
Wait for completion. Accepts an optional duration (e.g.,
5m, 30s). Defaults to 10m if no duration is specified.Auth Sessions Validate
Validate an existing auth session. While waiting, anyaskForInput or handoff interaction the operation starts is printed with the command that answers it. See Interactions Resolve.
Project name. See Project Name Resolution.
Auth Sessions Delete
Delete an auth session.Project name. See Project Name Resolution.
Interactions Resolve
Answer anaskForInput interaction, or open a handoff interaction’s page.
For an input interaction, the CLI prompts for the answer the same way a local run does: one prompt per field when the schema has only string, number, and boolean fields, and JSON otherwise. Press Esc to stop without answering. Pass --input to answer without prompting.
For a handoff, the CLI prints the handoff page’s link and asks whether to open it in your browser. The command then ends: press Done or Cancel on the page to finish the handoff.
The ID of the interaction, for example
ia_V1StGXR8Z5jdHi6B. Runs Get lists a Run’s pending interactions.Input interactions only. The answer as JSON, or a path to a JSON file. Required when the terminal isn’t interactive or
--json is set. Quote JSON strings: --input '"123456"'.Workspace viewers can’t answer or cancel interactions. The Run checks the answer against its schema: an answer that doesn’t match makes
askForInput throw InteractionInputValidationError.Interactions Cancel
Cancel an interaction instead of answering it. The Run’saskForInput or handoff throws InteractionCanceledError.
Skip the confirmation prompt. Required when the terminal isn’t interactive or
--json is set.Jobs List
List Jobs for a project.Project name. See Project Name Resolution.
Jobs Get
Get detailed information about a Job.Project name. See Project Name Resolution.
Jobs Create
Create a new Job.Project name. See Project Name Resolution.
Jobs Update
Update an existing Job.Project name. See Project Name Resolution.
Jobs Trigger
Manually trigger a Job run.Project name. See Project Name Resolution.
Jobs Pause
Pause a Job. Scheduled runs stop until the Job is resumed.Project name. See Project Name Resolution.
Jobs Resume
Resume a paused Job.Project name. See Project Name Resolution.
Jobs Delete
Delete a Job. Asks for confirmation unless-y / --yes is passed.
Project name. See Project Name Resolution.
JobRuns List
List JobRuns for a specific job.Project name. See Project Name Resolution.
JobRuns Get
Get detailed information about a JobRun.Project name. See Project Name Resolution.
JobRuns Terminate
Terminate a running JobRun. The CLI resolves the Job from the JobRun ID.Project name. See Project Name Resolution.
Issues List
List issues for a project.Project name. See Project Name Resolution.
Issues Get
Get detailed information about an issue.Project name. See Project Name Resolution.
Env Vars List
List environment variables for a project.Project name. See Project Name Resolution.
Env Vars Get
Get details of an environment variable by key.Project name. See Project Name Resolution.
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.
Env Vars Update
Update an existing environment variable by key.Project name. See Project Name Resolution.
Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Env Vars Delete
Delete an environment variable by key.Project name. See Project Name Resolution.
Workspace Env Vars List
List workspace-level environment variables.Workspace Env Vars Get
Get details of a workspace environment variable by key.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.
Workspace Env Vars Update
Update an existing workspace environment variable by key.Updated variable key. Must be 1–100 characters, alphanumeric or underscore, and cannot start with a digit.
Workspace Env Vars Delete
Delete a workspace environment variable by key.Project List
List all projects in the workspace.Project Get
Get detailed information about the current project.Project name. See Project Name Resolution.
Web Tasks Start
Start a new Web Task. Returns thewebTaskId immediately; use webtasks result to fetch the result.
Reuse key for persisted task resources. If omitted, the server generates one and returns it in the result.
Web Tasks Run
Start a Web Task and block until it reaches a terminal state (completed or canceled).
Reuse key for persisted task resources. If omitted, the server generates one and returns it in the result.
Web Tasks Result
Fetch the current status and result of a Web Task.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.