MCPcopy Index your code
hub / github.com/appium/appium-adb

github.com/appium/appium-adb @v15.0.8

Chat with this repo
repository ↗ · DeepWiki ↗ · release v15.0.8 ↗ · + Follow
352 symbols 713 edges 58 files 20 documented · 6% 2 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

appium-adb

NPM version Downloads

A wrapper over Android Debugger Bridge, implemented using ES6 and along with async/await. This package is mainly used by Appium to perform all adb operations on Android devices.

Installing

npm install appium-adb

Watch

npm run dev

Test

unit tests

npm run test

functional tests

By default the functional tests use an avd named NEXUS_S_18_X86, with API Level 18. To change this, you can use the environment variables PLATFORM_VERSION, API_LEVEL, and ANDROID_AVD. If PLATFORM_VERSION is set then it is not necessary to set API_LEVEL as it will be inferred.

npm run e2e-test

Usage:

example:

import { ADB } from 'appium-adb';

const adb = await ADB.createADB();
console.log(await adb.getPIDsByName('com.android.phone'));

Extension points exported contracts — how you extend this code

ADBOptions (Interface)
(no doc) [1 implementers]
lib/types.ts
LogcatOptions (Interface)
(no doc)
lib/logcat.ts
StartCmdOptions (Interface)
(no doc)
lib/tools/app-commands.ts
BuildInstallArgsOptions (Interface)
(no doc)
lib/utils/helpers/install.ts
ADBExecutable (Interface)
(no doc)
lib/types.ts
ApkCreationOptions (Interface)
(no doc)
lib/tools/types.ts
LogcatOpts (Interface)
(no doc)
lib/tools/types.ts
ResolveActivityOptions (Interface)
(no doc)
lib/tools/types.ts

Core symbols most depended-on inside this repo

resolve
called by 50
lib/logcat.ts
createADB
called by 15
lib/adb.ts
buildStartCmd
called by 14
lib/tools/app-commands.ts
isShowingLockscreen
called by 8
lib/tools/lockmgmt.ts
startCapture
called by 7
lib/logcat.ts
extractMatchingPermissions
called by 7
lib/tools/app-commands.ts
clear
called by 6
lib/logcat.ts
assertSafeComponentName
called by 6
lib/tools/app-commands.ts

Shape

Function 288
Interface 48
Method 12
Class 4

Languages

TypeScript100%

Modules by API surface

lib/tools/types.ts43 symbols
lib/tools/device-settings.ts43 symbols
lib/tools/app-commands.ts41 symbols
lib/tools/system-calls.ts40 symbols
lib/tools/emulator-commands.ts22 symbols
lib/tools/general-commands.ts18 symbols
lib/tools/lockmgmt.ts16 symbols
lib/logcat.ts16 symbols
lib/tools/apk-utils.ts15 symbols
lib/tools/keyboard-commands.ts13 symbols
lib/tools/apk-signing.ts10 symbols
lib/tools/network-commands.ts9 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

For agents

$ claude mcp add appium-adb \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page