https://github.com/appium/appium-idb
idb integration for Appium
https://github.com/appium/appium-idb
Last synced: 5 months ago
JSON representation
idb integration for Appium
- Host: GitHub
- URL: https://github.com/appium/appium-idb
- Owner: appium
- License: apache-2.0
- Created: 2019-05-17T11:33:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-21T11:04:24.000Z (6 months ago)
- Last Synced: 2026-01-21T18:56:50.776Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 9 MB
- Stars: 82
- Watchers: 17
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
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
```js
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
```