Overview

This section documents all the APIs in Tango ADB libraries.

There are three sub categories:

Adb from @yume-chan/adb:

The Adb class implements core ADB commands. These commands are handle by ADB Daemon on Android devices.

• Forward tunnel: Connect to a socket address on the device
• subprocess: Spawn processes on device
• power: Shutdown/reboot device
• reverse: Manage reverse port forwarding
• tcpip: Enable/disable ADB over Wi-Fi
• getProp: Shorthand for getprop executable
• rm: Delete files on device
• sync: Interact with device filesystem
• framebuffer: Capture device screen

AdbServerClient from @yume-chan/adb

The AdbServerClient class can communicate with Google ADB Server.

There are two types of ADB server commands:

Commands handled by server itself

• getVersion: Get ADB server version
• killServer: Kill ADB server
• getServerFeatures: Get ADB server features
• getDevices: Get devices connected to ADB server
• trackDevices: Watch devices connected to ADB server

Commands handled by device

These commands target a specific device. All these commands accepts a Device selector.

• getDeviceFeatures: Get device features
• createDeviceConnection: Create a socket to ADB Daemon on device
• createTransport: Create an AdbTransport object for the device, for low-level usages
• createAdb: Creates an Adb object for the device, for high-level usages
• waitFor: Wait for a device to be connected or disconnected

@yume-chan/android-bin

Exposed as individual classes from @yume-chan/android-bin package, these are abstractions over Android executables.

npm

npm i @yume-chan/android-bin

Yarn

yarn add @yume-chan/android-bin

pnpm

pnpm add @yume-chan/android-bin

Bun

bun add @yume-chan/android-bin

• bu: Backup/restore apps and data
• bugreport: Dump device information
• cmd: Interact with Android system services
• Demo mode: Control demo mode
• dumpsys: Dump system service information
• logcat: View device logs
  • binary: Read logcat entries in binary format
  • clear: Delete all logcat entries
• Overlay Display Manages simulated secondary displays
• pm: Manage apps
  • install: Install APK files on device filesystem
  • installStream: Install APK files from a ReadableStream
• settings: Get/set Android system settings

note

Documentation for each executable is in progress.