appium-idb

appium-idb is NodeJS wrapper over iOS Device Bridge (idb) set of utilities made by Facebook. Read https://www.fbidb.io for more details.

Requirements

• Python 3.6 or newer
• XCode 10 or newer
• idb_companion 1.1.7 or newer
• idb 1.1.7 or newer

Installation

Use the following commands to setup idb and its dependencies:

brew tap facebook/fb
brew install idb-companion
pip3.6 install fb-idb

Usage

const idb = IDB({
  udid: deviceUdid,
});
await idb.connect();
const deviceInfo = await idb.describeDevice();
await idb.disconnect();

Check https://github.com/appium/appium-idb/blob/master/lib/idb.js on the list of supported IDB options. udid option is mandatory and can be both Simulator or real device id. It is mandatory to call connect method before invoking idb instance methods (this will trigger idb companion and idb daemon processes if necessary). Calling disconnect will stop the previously started companion processes.

Go through the modules in https://github.com/appium/appium-idb/tree/master/lib/tools to get the full list of supported commands.

Watch

npm run watch

Test

npm test

1.8.22 (2025-01-05)

Miscellaneous Chores

• Bump @appium/eslint-config-appium-ts from 0.3.3 to 1.0.1 (#135) (b9abb48)

1.8.21 (2024-12-06)

Miscellaneous Chores

• Bump @appium/support from 5.1.8 to 6.0.0 (#134) (4d3e265)

1.8.20 (2024-12-03)

Miscellaneous Chores

• Bump mocha from 10.8.2 to 11.0.1 (#133) (aa3711e)

1.8.19 (2024-07-29)

Miscellaneous Chores

• Bump @types/node from 20.14.13 to 22.0.0 (#131) (7f33754)

1.8.18 (2024-07-09)

Miscellaneous Chores

• Remove extra import (787cc98)

1.8.17 (2024-06-19)

Miscellaneous Chores

• Bump chai and chai-as-promised (#130) (e7580bd)

1.8.16 (2024-06-12)

Miscellaneous Chores

• Bump @appium/support from 4.5.0 to 5.0.3 (#129) (d35d9ad)

1.8.15 (2024-06-04)

Miscellaneous Chores

• Bump semantic-release from 23.1.1 to 24.0.0 and conventional-changelog-conventionalcommits to 8.0.0 (#126) (22b6a9a)

1.8.14 (2024-05-16)

Miscellaneous Chores

• Update dev dependencies (2b29b4f)

1.8.13 (2024-04-09)

Miscellaneous Chores

• Remove extra imports (fc76d22)

1.8.12 (2024-04-09)

Miscellaneous Chores

• Bump @typescript-eslint/parser from 6.21.0 to 7.6.0 (#123) (eb54be0)

1.8.11 (2024-03-07)

Miscellaneous Chores

• bump typescript (d592b84)

1.8.10 (2024-01-17)

Miscellaneous Chores

• Bump semantic-release from 22.0.12 to 23.0.0 (#111) (0446dff)
• use latest lts for the publishment (d393fae)

1.8.9 (2023-11-06)

Miscellaneous Chores

• Bump @types/sinon from 10.0.20 to 17.0.0 (#106) (7a1f7da)

1.8.8 (2023-11-01)

Miscellaneous Chores

• Bump asyncbox from 2.9.4 to 3.0.0 (#105) (6826391)

1.8.7 (2023-10-25)

Miscellaneous Chores

• Bump eslint-config-prettier from 8.10.0 to 9.0.0 (#102) (3f536e9)
• Bump lint-staged from 14.0.1 to 15.0.2 (#100) (ab3e9f9)
• Bump semantic-release from 21.1.2 to 22.0.5 (#94) (93e830a)

1.8.6 (2023-10-25)

Miscellaneous Chores

• Bump @typescript-eslint/eslint-plugin from 5.62.0 to 6.9.0 (#104) (d3d5cea)

1.8.5 (2023-10-19)

Miscellaneous Chores

• Use latest teen_process types (929b7fd)

1.8.4 (2023-10-19)

Miscellaneous Chores

• Use latest types (41f3b4c)

1.8.3 (2023-09-14)

Miscellaneous Chores

• Bump @types/teen_process from 2.0.0 to 2.0.1 (#90) (962406a)

1.8.2 (2023-09-07)

Bug Fixes

• Make sure the streaming process is killed on falure (605552e)

1.8.1 (2023-09-07)

Miscellaneous Chores

• Add more video recording options (#88) (020c015)

1.8.0 (2023-09-07)

Features

• Add video-stream command support (#87) (ebb0c48)

1.7.0 (2023-08-31)

Features

• Switch babel to typescript (#84) (68ebc60)

1.6.16 (2023-08-28)

Miscellaneous Chores

• Bump conventional-changelog-conventionalcommits (#83) (39ef08e)

1.6.15 (2023-08-25)

Miscellaneous Chores

• Bump semantic-release from 20.1.3 to 21.1.0 (#82) (b259d78)

1.6.14 (2023-08-14)

Miscellaneous Chores

• Bump lint-staged from 13.3.0 to 14.0.0 (#80) (b330486)

1.6.13 (2023-07-07)

Miscellaneous Chores

• Bump prettier from 2.8.8 to 3.0.0 (#79) (77745fc)

1.6.12 (2023-06-07)

Miscellaneous Chores

• Bump conventional-changelog-conventionalcommits (#75) (e352264)

1.6.11 (2023-05-18)

Miscellaneous Chores

• Bump @appium/support from 3.1.11 to 4.0.0 (#73) (f7c2967)

1.6.10 (2023-01-17)

Miscellaneous Chores

• Bump semantic-release from 19.0.5 to 20.0.2 (#68) (26618f4)

1.6.9 (2022-12-27)

Bug Fixes

• stop manually starting a companion process (#65) (aaeefb3)

1.6.8 (2022-12-18)

Bug Fixes

• describeDevice fails to parse a valid json (#64) (1668962)

1.6.7 (2022-12-17)

Miscellaneous Chores

• Bump @appium/support from 2.61.1 to 3.0.0 (#62) (b539ab9)

1.6.6 (2022-12-11)

Miscellaneous Chores

• Update idb startup logic (#61) (c2ed8e9)

1.6.5 (2022-12-01)

Miscellaneous Chores

• update releaserc (#60) (3218d72)

1.6.4 (2022-11-07)

1.6.3 (2022-11-06)