Scroll to navigation

ADB(1) User Commands ADB(1)

NAME

adb - Android platform tools

DESCRIPTION

Android Debug Bridge version 1.0.41 Version 35.0.1-android-tools Running on Linux 6.8.7-1-default (x86_64)

global options:

listen on all network interfaces, not just localhost
use USB device (error if multiple devices connected)
use TCP/IP device (error if multiple TCP/IP devices available)
use device with given serial (overrides $ANDROID_SERIAL)
use device with given transport id
name of adb server host [default=localhost]
port of adb server [default=5037]
listen on given socket for adb server [default=tcp:localhost:5037]
only allowed with 'start-server' or 'server nodaemon', server will only connect to one USB device, specified by a serial number or USB device address.
exit if stdout is closed

general commands:

list connected devices (-l for long output)
show this help message
show version num

networking:

connect to a device via TCP/IP [default port=5555]
disconnect [HOST[:PORT]]
disconnect from given TCP/IP device [default port=5555], or all
pair HOST[:PORT] [PAIRING CODE]
pair with a device for secure TCP/IP communication
list all forward socket connections
forward [--no-rebind] LOCAL REMOTE
forward socket connection using:
tcp:<port> (<local> may be "tcp:0" to pick any open port) localabstract:<unix domain socket name> localreserved:<unix domain socket name> localfilesystem:<unix domain socket name> dev:<character device name> jdwp:<process pid> (remote only) vsock:<CID>:<port> (remote only) acceptfd:<fd> (listen only)
remove specific forward socket connection
remove all forward socket connections
list all reverse socket connections from device
reverse [--no-rebind] REMOTE LOCAL
reverse socket connection using:
tcp:<port> (<remote> may be "tcp:0" to pick any open port) localabstract:<unix domain socket name> localreserved:<unix domain socket name> localfilesystem:<unix domain socket name>
remove specific reverse socket connection
remove all reverse socket connections from device
check if mdns discovery is available
list all discovered services

file transfer:

push [--sync] [-z ALGORITHM] [-Z] LOCAL... REMOTE
copy local files/directories to device --sync: only push files that have different timestamps on the host than the device -n: dry run: push files to device without storing to the filesystem -z: enable compression with a specified algorithm (any/none/brotli/lz4/zstd) -Z: disable compression
pull [-a] [-z ALGORITHM] [-Z] REMOTE... LOCAL
copy files/dirs from device -a: preserve file timestamp and mode -z: enable compression with a specified algorithm (any/none/brotli/lz4/zstd) -Z: disable compression
sync [-l] [-z ALGORITHM] [-Z] [all|data|odm|oem|product|system|system_ext|vendor]
sync a local build from $ANDROID_PRODUCT_OUT to the device (default all) -n: dry run: push files to device without storing to the filesystem -l: list files that would be copied, but don't copy them -z: enable compression with a specified algorithm (any/none/brotli/lz4/zstd) -Z: disable compression

shell:

shell [-e ESCAPE] [-n] [-Tt] [-x] [COMMAND...]
run remote shell command (interactive shell if no command given) -e: choose escape character, or "none"; default '~' -n: don't read from stdin -T: disable pty allocation -t: allocate a pty if on a tty (-tt: force pty allocation) -x: disable remote exit codes and stdout/stderr separation
run emulator console command

app installation (see also `adb shell cmd package help`):

install [-lrtsdg] [--instant] PACKAGE
push a single package to the device and install it
install-multiple [-lrtsdpg] [--instant] PACKAGE...
push multiple APKs to the device for a single package and install them
install-multi-package [-lrtsdpg] [--instant] PACKAGE...
push one or more packages to the device and install them atomically -r: replace existing application -t: allow test packages -d: allow version code downgrade (debuggable packages only) -p: partial application install (install-multiple only) -g: grant all runtime permissions --abi ABI: override platform's default ABI --instant: cause the app to be installed as an ephemeral install app --no-streaming: always push APK to device and invoke Package Manager as separate steps --streaming: force streaming APK directly into Package Manager --fastdeploy: use fast deploy --no-fastdeploy: prevent use of fast deploy --force-agent: force update of deployment agent when using fast deploy --date-check-agent: update deployment agent when local version is newer and using fast deploy --version-check-agent: update deployment agent when local version has different version code and using fast deploy --local-agent: locate agent files from local source build (instead of SDK location) (See also `adb shell pm help` for more options.)
uninstall [-k] PACKAGE
remove this app package from the device '-k': keep the data and cache directories

debugging:

bugreport [PATH]
write bugreport to given PATH [default=bugreport.zip]; if PATH is a directory, the bug report is saved in that directory. devices that don't support zipped bug reports output to stdout.
list pids of processes hosting a JDWP transport
show device log (logcat --help for more)

security:

disable dm-verity checking on userdebug builds
re-enable dm-verity checking on userdebug builds
keygen FILE
generate adb public/private key; private key stored in FILE,

scripting:

wait-for[-TRANSPORT]-STATE...
wait for device to be in a given state STATE: device, recovery, rescue, sideload, bootloader, or disconnect TRANSPORT: usb, local, or any [default=any]
print offline | bootloader | device
print <serial-number>
print <device-path>
remount [-R]
remount partitions read-write. if a reboot is required, -R will will automatically reboot the device.
reboot [bootloader|recovery|sideload|sideload-auto-reboot]
reboot the device; defaults to booting system image but supports bootloader and recovery too. sideload reboots into recovery and automatically starts sideload mode, sideload-auto-reboot is the same but reboots after sideloading.
sideload the given full OTA package
restart adbd with root permissions
restart adbd without root permissions
restart adbd listening on USB
restart adbd listening on TCP on PORT

internal debugging:

ensure that there is a server running
kill the server if it is running
kick connection from host side to force reconnect
reconnect device
kick connection from device side to force reconnect
reconnect offline
reset offline/unauthorized devices to force reconnect

usb:

attach a detached USB device
detach from a USB device to allow use by other processes

environment variables:

$ADB_TRACE
comma/space separated list of debug info to log: all,adb,sockets,packets,rwx,usb,sync,sysdeps,transport,jdwp
$ADB_VENDOR_KEYS
colon-separated list of keys (files or directories)
$ANDROID_SERIAL
serial number to connect to (see -s)
$ANDROID_LOG_TAGS
tags to be used by logcat (see logcat --help)
$ADB_LOCAL_TRANSPORT_MAX_PORT max emulator scan port (default 5585, 16 emus) $ADB_MDNS_AUTO_CONNECT comma-separated list of mdns services to allow auto-connect (default adb-tls-connect)

Online documentation: https://android.googlesource.com/platform/packages/modules/adb/+/refs/heads/main/docs/user/adb.1.md

April 2024 adb 35.0.1