README
¶
go-adb
Go ADB library.
- Full control over timeouts and cancellation.
- High-level idiomatic Go wrappers around common functionality.
- Access to low-level protocol details where required.
- All errors are checked.
- Focused on modern APIs; legacy ADB behaviour is not a priority.
- Highly extensible.
- Robust
os/exec-style wrapper for shell commands with streaming, exit code support, split stderr/stdout, pty support, and error handling. - Support for exposing an existing device as an
adb connectable target. - Completely hand-written and carefully designed (no AI involvement at all).
[!WARNING] This library is a work-in-progress. The API is experimental and subject to change, and some features are missing. However, the functionality which has been implemented is stable and I'm using it heavily in other projects.
To keep this library maintainable and reduce the risk of breakage across versions, features not part of the core adb protocol are out of scope for this library. This includes interacting with on-device commands like am, pm, input, and so in, including through abb. These features could be implemented as part of another library if needed.
The adb package contains thin idiomatic Go wrappers around core ADB functionality, with the adb/adbproto package implementing low-level ADB protocol primitives (based on how the Android works).
The adblib package implements opionated high-level wrappers around ADB functionality resembling the API of the corresponding Go stdlib packages (e.g., adblib/adbnet for net, adblib/adbexec/v2 for os/exec, adblib/adbsync for os), plus unique functionality like adblib/adbproxy.
The examples folder contains some working examples using go-adb, but is still relatively incomplete.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adb interacts with ADB servers.
|
Package adb interacts with ADB servers. |
|
adbhost
Package adbhost connects to an ADB host server.
|
Package adbhost connects to an ADB host server. |
|
adbproto
Package adbproto implements the core ADB protocol.
|
Package adbproto implements the core ADB protocol. |
|
adbproto/adbpb
Package adbppb contains adb protobuf definitions.
|
Package adbppb contains adb protobuf definitions. |
|
adbproto/aproto
Package aproto implements the lower level transport protocol used by ADB.
|
Package aproto implements the lower level transport protocol used by ADB. |
|
adbproto/atransport
Package atransport implements the host side of the ADB transport protocol, authenticating with and connecting to an ADB server (i.e., device) over an arbitrary connection.
|
Package atransport implements the host side of the ADB transport protocol, authenticating with and connecting to an ADB server (i.e., device) over an arbitrary connection. |
|
adbproto/jdwp
Package jdwp implements types to communicate using the the Java Debug Wire Protocol.
|
Package jdwp implements types to communicate using the the Java Debug Wire Protocol. |
|
adbproto/shellproto2
Package shellproto2 implements the shell v2 protocol.
|
Package shellproto2 implements the shell v2 protocol. |
|
adbtcpip
Package adbtcpip authenticates with and connects to an ADB server over TCP/IP.
|
Package adbtcpip authenticates with and connects to an ADB server over TCP/IP. |
|
adbusb
Package adbusb authenticates with and connects to an ADB device over USB.
|
Package adbusb authenticates with and connects to an ADB device over USB. |
|
Package adblib provides high-level ADB functionality.
|
Package adblib provides high-level ADB functionality. |
|
adbexec
Package adbexec implements a high-level interface around the legacy shell and exec protocols.
|
Package adbexec implements a high-level interface around the legacy shell and exec protocols. |
|
adbexec/v2
Package adbexec implements a high-level interface around the shell v2 protocol.
|
Package adbexec implements a high-level interface around the shell v2 protocol. |
|
adbnet
Package adbnet implements helpers for making connections throughand listening on the target device.
|
Package adbnet implements helpers for making connections throughand listening on the target device. |
|
adbproxy
Package adbproxy implements ADB-over-TCP/IP for an existing ADB server.
|
Package adbproxy implements ADB-over-TCP/IP for an existing ADB server. |
|
adbsync
Package adbsync wraps the sync protocol.
|
Package adbsync wraps the sync protocol. |
|
internal
|
|
|
bionic
Package bionic contains stuff for working with bionic libc types.
|
Package bionic contains stuff for working with bionic libc types. |