Simulators and emulators of your own

cleanup_simulator_acquire

Get an iOS simulator of your own: a clone of a shut-down device, or a new device of a type, named for this session so that no other agent uses it and only this session's cleanup removes it. Use it instead of booting a simulator somebody may already be using, and drive it by the udid it returns. A job.

only adds · every call adds · stays on this machine.

Parameter Type Required Default Description
from string? — null A shut-down device to clone, by name or udid, or a device type such as iPhone 17 Pro; the newest iPhone Pro when omitted.
boot boolean — false Whether to boot it and wait until it is ready; false by default.
wait integer — 60 Seconds to wait before answering with the running job, a resource to read; 60 by default.
JSON Schema
{
  "type": "object",
  "properties": {
    "from": {
      "description": "A shut-down device to clone, by name or udid, or a device type such as iPhone 17 Pro; the newest iPhone Pro when omitted.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "boot": {
      "description": "Whether to boot it and wait until it is ready; false by default.",
      "type": "boolean",
      "default": false
    },
    "wait": {
      "description": "Seconds to wait before answering with the running job, a resource to read; 60 by default.",
      "type": "integer",
      "default": 60
    }
  }
}

cleanup_emulator_acquire

Get an Android emulator of your own: a new virtual device from an installed system image, started on a free console port without saving a snapshot, named for this session so that only its cleanup removes it. It returns the adb serial once the emulator starts; the device needs a minute or two to boot. A job.

only adds · every call adds · stays on this machine.

Parameter Type Required Default Description
image string? — null Part of an installed system image path, such as android-37.0 or google_apis; the newest image without the Play Store when omitted.
window boolean — false Whether to show the emulator's window; false runs it headless.
wait integer — 60 Seconds to wait before answering with the running job, a resource to read; 60 by default.
JSON Schema
{
  "type": "object",
  "properties": {
    "image": {
      "description": "Part of an installed system image path, such as android-37.0 or google_apis; the newest image without the Play Store when omitted.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "window": {
      "description": "Whether to show the emulator\u0027s window; false runs it headless.",
      "type": "boolean",
      "default": false
    },
    "wait": {
      "description": "Seconds to wait before answering with the running job, a resource to read; 60 by default.",
      "type": "integer",
      "default": 60
    }
  }
}