- Android Debug Bridge
- In this document
- Enabling adb Debugging
- Syntax
- Commands
- Querying for Emulator/Device Instances
- Directing Commands to a Specific Emulator/Device Instance
- Installing an Application
- Forwarding Ports
- Copying Files to or from an Emulator/Device Instance
- Stopping the adb Server
- Wireless usage
- ADB Shell Commands
- In this document
- Issuing Shell Commands
- Using activity manager (am)
- Specification for arguments
- Using package manager (pm)
- Taking a device screenshot
- Recording a device screen
- Other shell commands
Android Debug Bridge
In this document
Android Debug Bridge (adb) is a versatile command line tool that lets you communicate with an emulator instance or connected Android-powered device. It is a client-server program that includes three components:
- A client, which runs on your development machine. You can invoke a client from a shell by issuing an adb command. Other Android tools such as the ADT plugin and DDMS also create adb clients.
- A server, which runs as a background process on your development machine. The server manages communication between the client and the adb daemon running on an emulator or device.
- A daemon, which runs as a background process on each emulator or device instance.
You can find the adb tool in /platform-tools/ .
When you start an adb client, the client first checks whether there is an adb server process already running. If there isn’t, it starts the server process. When the server starts, it binds to local TCP port 5037 and listens for commands sent from adb clients—all adb clients use port 5037 to communicate with the adb server.
The server then sets up connections to all running emulator/device instances. It locates emulator/device instances by scanning odd-numbered ports in the range 5555 to 5585, the range used by emulators/devices. Where the server finds an adb daemon, it sets up a connection to that port. Note that each emulator/device instance acquires a pair of sequential ports — an even-numbered port for console connections and an odd-numbered port for adb connections. For example:
Emulator 1, console: 5554
Emulator 1, adb: 5555
Emulator 2, console: 5556
Emulator 2, adb: 5557
and so on.
As shown, the emulator instance connected to adb on port 5555 is the same as the instance whose console listens on port 5554.
Once the server has set up connections to all emulator instances, you can use adb commands to access those instances. Because the server manages connections to emulator/device instances and handles commands from multiple adb clients, you can control any emulator/device instance from any client (or from a script).
Enabling adb Debugging
In order to use adb with a device connected over USB, you must enable USB debugging in the device system settings, under Developer options.
On Android 4.2 and higher, the Developer options screen is hidden by default. To make it visible, go to Settings > About phone and tap Build number seven times. Return to the previous screen to find Developer options at the bottom.
On some devices, the Developer options screen may be located or named differently.
Note: When you connect a device running Android 4.2.2 or higher to your computer, the system shows a dialog asking whether to accept an RSA key that allows debugging through this computer. This security mechanism protects user devices because it ensures that USB debugging and other adb commands cannot be executed unless you’re able to unlock the device and acknowledge the dialog. This requires that you have adb version 1.0.31 (available with SDK Platform-tools r16.0.1 and higher) in order to debug on a device running Android 4.2.2 or higher.
For more information about connecting to a device over USB, read Using Hardware Devices.
Syntax
You can issue adb commands from a command line on your development machine or from a script. The usage is:
If there’s only one emulator running or only one device connected, the adb command is sent to that device by default. If multiple emulators are running and/or multiple devices are attached, you need to use the -d , -e , or -s option to specify the target device to which the command should be directed.
Commands
The table below lists all of the supported adb commands and explains their meaning and usage.
Table 1. Available adb commands
Category | Command | Description | Comments |
---|---|---|---|
Target Device | -d | Direct an adb command to the only attached USB device. | Returns an error if more than one USB device is attached. |
-e | Direct an adb command to the only running emulator instance. | Returns an error if more than one emulator instance is running. | |
-s | Direct an adb command a specific emulator/device instance, referred to by its adb-assigned serial number (such as «emulator-5556»). | See Directing Commands to a Specific Emulator/Device Instance. | |
General | devices | Prints a list of all attached emulator/device instances. | See Querying for Emulator/Device Instances for more information. |
help | Prints a list of supported adb commands. | ||
version | Prints the adb version number. | ||
Debug | logcat [option] [filter-specs] | Prints log data to the screen. | |
bugreport | Prints dumpsys , dumpstate , and logcat data to the screen, for the purposes of bug reporting. | ||
jdwp | Prints a list of available JDWP processes on a given device. | You can use the forward jdwp: port-forwarding specification to connect to a specific JDWP process. For example: | |
Data | install | Pushes an Android application (specified as a full path to an .apk file) to an emulator/device. | |
pull | Copies a specified file from an emulator/device instance to your development computer. | ||
push | Copies a specified file from your development computer to an emulator/device instance. | ||
Ports and Networking | forward | Forwards socket connections from a specified local port to a specified remote port on the emulator/device instance. | Port specifications can use these schemes:
|
ppp [parm]. | Run PPP over USB.
Note that you should not automatically start a PPP connection. | ||
Scripting | get-serialno | Prints the adb instance serial number string. | See Querying for Emulator/Device Instances for more information. |
get-state | Prints the adb state of an emulator/device instance. | ||
wait-for-device | Blocks execution until the device is online — that is, until the instance state is device . | You can prepend this command to other adb commands, in which case adb will wait until the emulator/device instance is connected before issuing the other commands. Here’s an example: Note that this command does not cause adb to wait until the entire system is fully booted. For that reason, you should not prepend it to other commands that require a fully booted system. As an example, the install requires the Android package manager, which is available only after the system is fully booted. A command such as would issue the install command as soon as the emulator or device instance connected to the adb server, but before the Android system was fully booted, so it would result in an error. | |
Server | start-server | Checks whether the adb server process is running and starts it, if not. | |
kill-server | Terminates the adb server process. | ||
Shell | shell | Starts a remote shell in the target emulator/device instance. | See ADB Shell Commands for more information. |
shell [shellCommand] | Issues a shell command in the target emulator/device instance and then exits the remote shell. |
Querying for Emulator/Device Instances
Before issuing adb commands, it is helpful to know what emulator/device instances are connected to the adb server. You can generate a list of attached emulators/devices using the devices command:
In response, adb prints this status information for each instance:
- Serial number — A string created by adb to uniquely identify an emulator/device instance by its console port number. The format of the serial number is — . Here’s an example serial number: emulator-5554
- State — The connection state of the instance may be one of the following:
- offline — the instance is not connected to adb or is not responding.
- device — the instance is now connected to the adb server. Note that this state does not imply that the Android system is fully booted and operational, since the instance connects to adb while the system is still booting. However, after boot-up, this is the normal operational state of an emulator/device instance.
- no device — there is no emulator/device connected.
The output for each instance is formatted like this:
Here’s an example showing the devices command and its output:
Directing Commands to a Specific Emulator/Device Instance
If multiple emulator/device instances are running, you must specify a target instance when issuing adb commands. To do so, use the -s option in the commands. The usage for the -s option is:
As shown, you specify the target instance for a command using its adb-assigned serial number. You can use the devices command to obtain the serial numbers of running emulator/device instances. For example:
Note that, if you issue a command without specifying a target emulator/device instance while multiple devices are available, adb generates an error.
If you have multiple devices available (hardware or emulated), but only one is an emulator, simply use the -e option to send commands to the emulator. Likewise if there’s multiple devices but only one hardware device attached, use the -d option to send commands to the hardware device.
Installing an Application
You can use adb to copy an application from your development computer and install it on an emulator/device instance. To do so, use the install command. With the command, you must specify the path to the .apk file that you want to install:
For more information about how to create an .apk file that you can install on an emulator/device instance, see Building and Running
Note that, if you are using the Eclipse IDE and have the ADT plugin installed, you do not need to use adb (or aapt) directly to install your application on the emulator/device. Instead, the ADT plugin handles the packaging and installation of the application for you.
Forwarding Ports
You can use the forward command to set up arbitrary port forwarding — forwarding of requests on a specific host port to a different port on an emulator/device instance. Here’s how you would set up forwarding of host port 6100 to emulator/device port 7100:
You can also use adb to set up forwarding to named abstract UNIX domain sockets, as illustrated here:
Copying Files to or from an Emulator/Device Instance
You can use the adb commands pull and push to copy files to and from an emulator/device instance. Unlike the install command, which only copies an APK file to a specific location, the pull and push commands let you copy arbitrary directories and files to any location in an emulator/device instance.
To copy a file or directory (and its sub-directories) from the emulator or device, use
To copy a file or directory (and its sub-directories) to the emulator or device, use
In the commands, and refer to the paths to the target files/directory on your development machine (local) and on the emulator/device instance (remote). For example:
Stopping the adb Server
In some cases, you might need to terminate the adb server process and then restart it to resolve the problem (e.g., if adb does not respond to a command).
To stop the adb server, use the kill-server command. You can then restart the server by issuing any other adb command.
Wireless usage
adb is usually used over USB. However, it is also possible to use over Wi-Fi, as described here.
- Connect Android device and adb host computer to a common Wi-Fi network accessible to both. We have found that not all access points are suitable; you may need to use an access point whose firewall is configured properly to support adb.
- Connect the device with USB cable to host.
- Make sure adb is running in USB mode on host.
- Connect to the device over USB.
- Restart host adb in tcpip mode.
- Find out the IP address of the Android device: Settings -> About tablet -> Status -> IP address. Remember the IP address, of the form #.#.#.# .
- Connect adb host to device:
- Remove USB cable from device, and confirm you can still access device:
You’re now good to go!
If the adb connection is ever lost:
- Make sure that your host is still connected to the same Wi-Fi network your Android device is.
- Reconnect by executing the «adb connect» step again.
- Or if that doesn’t work, reset your adb host: and then start over from the beginning.
Источник
ADB Shell Commands
In this document
The Android Debug Bridge (adb) provides a Unix shell that you can use to run a variety of commands on an emulator or connected device. The command binaries are stored in the file system of the emulator or device, at /system/bin/.
Issuing Shell Commands
You can use the shell command to issue commands, with or without entering the adb remote shell on the emulator/device. To issue a single command without entering a remote shell, use the shell command like this:
Or enter a remote shell on an emulator/device like this:
When you are ready to exit the remote shell, press CTRL+D or type exit .
Using activity manager (am)
Within an adb shell, you can issue commands with the activity manager ( am ) tool to perform various system actions, such as start an activity, force-stop a process, broadcast an intent, modify the device screen properties, and more. While in a shell, the syntax is:
You can also issue an activity manager command directly from adb without entering a remote shell. For example:
Table 2. Available activity manager commands
Command | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
start [options] | Start an Activity specified by . Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startservice [options] | Start the Service specified by . Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
force-stop | Force stop everything associated with (the app’s package name). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kill [options] | Kill all processes associated with (the app’s package name). This command kills only processes that are safe to kill and that will not impact the user experience. Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kill-all | Kill all background processes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
broadcast [options] | Issue a broadcast intent. Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instrument [options] | Start monitoring with an Instrumentation instance. Typically the target is the form / . Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile start | Start profiler on , write results to . | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile stop | Stop profiler on . | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dumpheap [options] | Dump the heap of Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
set-debug-app [options] | Set application Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clear-debug-app | Clear the package previous set for debugging with set-debug-app . | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
monitor [options] | Start monitoring for crashes or ANRs. Options are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
screen-compat [on|off] | Control screen compatibility mode of | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
display-size [reset| ] | Override emulator/device display size. This command is helpful for testing your app across different screen sizes by mimicking a small screen resolution using a device with a large screen, and vice versa. Example: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
display-density | Override emulator/device display density. This command is helpful for testing your app across different screen densities on high-density screen environment using a low density screen, and vice versa. Example: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to-uri | Print the given intent specification as a URI. See the Specification for arguments. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to-intent-uri | Print the given intent specification as an intent: URI. Specification for argumentsFor activity manager commands that take a argument, you can specify the intent with the following options: -a Specify the intent action, such as «android.intent.action.VIEW». You can declare this only once. -d Specify the intent data URI, such as «content://contacts/people/1». You can declare this only once. -t Specify the intent MIME type, such as «image/png». You can declare this only once. -c Specify an intent category, such as «android.intent.category.APP_CONTACTS». -n Specify the component name with package name prefix to create an explicit intent, such as «com.example.app/.ExampleActivity». -f Add flags to the intent, as supported by setFlags() . —esn Add a null extra. This option is not supported for URI intents. -e|—es Add string data as a key-value pair. —ez Add boolean data as a key-value pair. —ei Add integer data as a key-value pair. —el Add long data as a key-value pair. —ef Add float data as a key-value pair. —eu Add URI data as a key-value pair. —ecn Add a component name, which is converted and passed as a ComponentName object. —eia [, Add an array of integers. —ela [, Add an array of longs. —efa [, Add an array of floats. —grant-read-uri-permission Include the flag FLAG_GRANT_READ_URI_PERMISSION . —grant-write-uri-permission Include the flag FLAG_GRANT_WRITE_URI_PERMISSION . —debug-log-resolution Include the flag FLAG_DEBUG_LOG_RESOLUTION . —exclude-stopped-packages Include the flag FLAG_EXCLUDE_STOPPED_PACKAGES . —include-stopped-packages Include the flag FLAG_INCLUDE_STOPPED_PACKAGES . —activity-brought-to-front Include the flag FLAG_ACTIVITY_BROUGHT_TO_FRONT . —activity-clear-top Include the flag FLAG_ACTIVITY_CLEAR_TOP . —activity-clear-when-task-reset Include the flag FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET . —activity-exclude-from-recents Include the flag FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS . —activity-launched-from-history Include the flag FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY . —activity-multiple-task Include the flag FLAG_ACTIVITY_MULTIPLE_TASK . —activity-no-animation Include the flag FLAG_ACTIVITY_NO_ANIMATION . —activity-no-history Include the flag FLAG_ACTIVITY_NO_HISTORY . —activity-no-user-action Include the flag FLAG_ACTIVITY_NO_USER_ACTION . —activity-previous-is-top Include the flag FLAG_ACTIVITY_PREVIOUS_IS_TOP . —activity-reorder-to-front Include the flag FLAG_ACTIVITY_REORDER_TO_FRONT . —activity-reset-task-if-needed Include the flag FLAG_ACTIVITY_RESET_TASK_IF_NEEDED . —activity-single-top Include the flag FLAG_ACTIVITY_SINGLE_TOP . —activity-clear-task Include the flag FLAG_ACTIVITY_CLEAR_TASK . —activity-task-on-home Include the flag FLAG_ACTIVITY_TASK_ON_HOME . —receiver-registered-only Include the flag FLAG_RECEIVER_REGISTERED_ONLY . —receiver-replace-pending Include the flag FLAG_RECEIVER_REPLACE_PENDING . —selector Requires the use of -d and -t options to set the intent data and type. You can directly specify a URI, package name, and component name when not qualified by one of the above options. When an argument is unqualified, the tool assumes the argument is a URI if it contains a «:» (colon); it assumes the argument is a component name if it contains a «/» (forward-slash); otherwise it assumes the argument is a package name. Using package manager (pm)Within an adb shell, you can issue commands with the package manager ( pm ) tool to perform actions and queries on application packages installed on the device. While in a shell, the syntax is: You can also issue a package manager command directly from adb without entering a remote shell. For example: Table 3. Available package manager commands.
Taking a device screenshotThe screencap command is a shell utility for taking a screenshot of a device display. While in a shell, the syntax is: To use the screencap from the command line, type the following: Here’s an example screenshot session, using the adb shell to capture the screenshot and the pull command to download the file from the device: Recording a device screenThe screenrecord command is a shell utility for recording the display of devices running Android 4.4 (API level 19) and higher. The utility records screen activity to an MPEG-4 file. Note: Audio is not recorded with the video file. A developer can use this file to create promotional or training videos. While in a shell, the syntax is: To use screenrecord from the command line, type the following: Stop the screen recording by pressing Ctrl-C, otherwise the recording stops automatically at three minutes or the time limit set by —time-limit . To begin recording your device screen, run the screenrecord command to record the video. Then, run the pull command to download the video from the device to the host computer. Here’s an example recording session: The screenrecord utility can record at any supported resolution and bit rate you request, while retaining the aspect ratio of the device display. The utility records at the native display resolution and orientation by default, with a maximum length of three minutes. There are some known limitations of the screenrecord utility that you should be aware of when using it:
Table 4. screenrecord options
Other shell commandsFor a list of all the available shell programs, use the following command: Help is available for most of the commands. Table 5 lists some of the more common adb shell commands. Table 5. Some other adb shell commands Источник |