# appium-ios-simulator > iOS Simulator interface for Appium. Latest version **10.7.1** (published 2026-10-05) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install appium-ios-simulator pnpm add appium-ios-simulator yarn add appium-ios-simulator bun add appium-ios-simulator ``` ## Health **Score 75/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 10.7.1 | | Published | 2026-10-05 | | First published | 2015-08-10 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | ^20.19.0 \|\| ^22.12.0 \|\| >=24.0.0 | | Dependencies | 8 | | Unpacked size | 498.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 6 | | Author | Appium Contributors | | Maintainers | jlipps, nick.mokhnach, kazucocoa, imurchie, dangraham | | Keywords | appium, ios, simctl, simulator | ## Links - npm: https://www.npmjs.com/package/appium-ios-simulator - Repository: https://github.com/appium/appium-ios - Homepage: https://github.com/appium/appium-ios#readme - Issues: https://github.com/appium/appium-ios/issues - npm.io page: https://npm.io/package/appium-ios-simulator ## Dependencies (8) - [semver](https://npm.io/package/semver.md) ^7.8.5 - [asyncbox](https://npm.io/package/asyncbox.md) ^6.4.3 - [async-lock](https://npm.io/package/async-lock.md) ^1.0.0 - [appium-xcode](https://npm.io/package/appium-xcode.md) ^7.2.3 - [teen_process](https://npm.io/package/teen_process.md) ^4.2.0 - [@xmldom/xmldom](https://npm.io/package/@xmldom/xmldom.md) ^0.x - [@appium/coresim](https://npm.io/package/@appium/coresim.md) ^1.11.1 - [@appium/support](https://npm.io/package/@appium/support.md) ^7.2.7 ## Recent versions - 10.7.1 (latest) — 2026-10-05 - 1.1.0-beta (beta) — 2015-12-15 - 10.7.0 — 2026-10-03 - 10.6.0 — 2026-10-03 - 10.5.0 — 2026-10-02 - 10.4.2 — 2026-10-02 - 10.4.1 — 2026-10-01 - 10.4.0 — 2026-09-30 - 10.3.0 — 2026-09-29 - 10.2.0 — 2026-09-25 - 10.1.1 — 2026-09-23 - 10.1.0 — 2026-09-19 - 10.0.1 — 2026-09-18 - 10.0.0 — 2026-09-18 - 9.1.3 — 2026-09-01 - … 276 more at https://npm.io/package/appium-ios-simulator/versions ## README ## appium-ios-simulator [![NPM version](http://img.shields.io/npm/v/appium-ios-simulator.svg)](https://npmjs.org/package/appium-ios-simulator) [![Downloads](http://img.shields.io/npm/dm/appium-ios-simulator.svg)](https://npmjs.org/package/appium-ios-simulator) A Node.js API for controlling iOS simulators, used internally by [Appium](https://appium.io)'s [XCUITest driver](https://github.com/appium/appium-xcuitest-driver). It talks to `CoreSimulator.framework` directly through [`@appium/coresim`](https://github.com/appium/coresim), rather than shelling out to `xcrun simctl`, so most operations are faster and return typed, catchable errors instead of parsed CLI output. With it you can: - boot, shut down, erase, and otherwise manage the lifecycle of a simulator - install, launch, terminate, and inspect apps - grant, revoke, and query app permissions (contacts, camera, photos, and more) - control biometrics, geolocation, the pasteboard, and keychain - change UI settings (appearance, content size, contrast, localization, ...) - rotate the device to a specific orientation, or read its current one - capture screenshots, record the display to a file, or stream it as encoded H.264/HEVC or a live sequence of JPEG frames — optionally muxing/interleaving the device's own audio into the video paths (Xcode 26+) - add media to the Photos library, and spawn guest processes - look up Simulator-specific directories, apps, and settings on disk ### Requirements - macOS, with Xcode 15 or newer installed - Node.js `^20.19.0 || ^22.12.0 || >=24.0.0` ### Installation ```bash npm install appium-ios-simulator ``` ### Usage The main entry point is `getSimulator(udid)`, which returns a `Simulator` instance for an *existing* simulator (identified by its UDID, e.g. as reported by `xcrun simctl list devices`). To create a new device first, use [`@appium/coresim`](https://github.com/appium/coresim)'s `NativeSimctl#createDevice()`. ```js import { getSimulator } from 'appium-ios-simulator'; import assert from 'node:assert/strict'; const sim = await getSimulator('DAE95172-0788-4A85-8D0D-5C85509109E1'); await sim.run(); assert.equal('Booted', (await sim.stat()).state); await sim.installApp('/path/to/MyApp.app'); await sim.launchApp('com.example.MyApp'); await sim.setPermission('com.example.MyApp', 'photos', 'yes'); await sim.shutdown(); assert.equal('Shutdown', (await sim.stat()).state); ``` See [`lib/types.ts`](./lib/types.ts) for the full `Simulator` API surface, and [`test/functional/simulator-e2e.spec.ts`](./test/functional/simulator-e2e.spec.ts) for more end-to-end examples of most of it in action. `getSimulator()` also accepts a `devicesSetPath` option to target an isolated, non-default [device set](https://developer.apple.com/documentation/xcode/running-your-app-in-simulator) instead of the default one under `~/Library/Developer/CoreSimulator/Devices`. ### Pasteboard synchronization `sim.run({pasteboardAutomaticSync: 'off'})` disables synchronization with the macOS clipboard. On Xcode 27 and newer, this sets DeviceHub's **Use Shared Clipboard** preference for the selected simulator. Use `on` to enable synchronization or `system` to leave the existing preference unchanged. DeviceHub caches these preferences. Close DeviceHub before starting sessions when changing this setting so its next launch reads the updated preferences. The library does not restart an already-running DeviceHub, which could disrupt other sessions. Disable synchronization on every simulator used for parallel clipboard tests. ### Hardware keyboard `sim.run({connectHardwareKeyboard: true})` enables hardware keyboard simulation; `false` (the default) disables it. On Xcode 27 and newer, this sets DeviceHub's **Simulate Hardware Keyboard** preference via `alwaysSimulateHardwareKeyboard`. This is a global DeviceHub setting, shared by all devices and sessions. Parallel sessions must use the same value; different values per device are not supported. Close DeviceHub before starting sessions when changing this setting so its next launch reads the updated preference. The library does not restart DeviceHub automatically. ### Xcode and iOS versions Check the [Xcode Wikipedia page](https://en.wikipedia.org/wiki/Xcode) for the mapping between Xcode and iOS versions. Only Xcode 15 and newer are supported. ### Development Check out the repository and run: ```bash npm install npm run dev # tsc --watch ``` ```bash npm run lint # static analysis npm run format # code formatting ``` Use the following commands to run tests: ```bash npm run test # unit tests, no simulator required npm run e2e-test # functional tests against real simulators ``` --- _Source: https://npm.io/package/appium-ios-simulator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._