gadb

README

gadb

ADB Client in pure Golang.

Installation

go get github.com/electricbubble/gadb

Example

package main

import (
	"github.com/electricbubble/gadb"
	"log"
	"os"
	"strings"
)

func main() {
	adbClient, err := gadb.NewClient()
	checkErr(err, "fail to connect adb server")

	devices, err := adbClient.DeviceList()
	checkErr(err)

	if len(devices) == 0 {
		log.Fatalln("list of devices is empty")
	}

	dev := devices[0]

	userHomeDir, _ := os.UserHomeDir()
	apk, err := os.Open(userHomeDir + "/Desktop/xuexi_android_10002068.apk")
	checkErr(err)

	log.Println("starting to push apk")

	remotePath := "/data/local/tmp/xuexi_android_10002068.apk"
	err = dev.PushFile(apk, remotePath)
	checkErr(err, "adb push")

	log.Println("push completed")

	log.Println("starting to install apk")

	shellOutput, err := dev.RunShellCommand("pm install", remotePath)
	checkErr(err, "pm install")
	if !strings.Contains(shellOutput, "Success") {
		log.Fatalln("fail to install: ", shellOutput)
	}

	log.Println("install completed")

}

func checkErr(err error, msg ...string) {
	if err == nil {
		return
	}

	var output string
	if len(msg) != 0 {
		output = msg[0] + " "
	}
	output += err.Error()
	log.Fatalln(output)
}

Thanks

Thank you JetBrains for providing free open source licenses

---

Repository	Description
zach-klippenstein/goadb	A Golang library for interacting with adb.
vidstige/jadb	ADB Client in pure Java.
Swind/pure-python-adb	This is pure-python implementation of the ADB client.
codeskyblue/fa	FA(fast adb) helps you win at ADB(Android Debug Bridge).

Documentation

Index

• Constants
• Variables
• func SetDebug(debug bool)
• type Client
  • func NewClient() (Client, error)
  • func NewClientWith(host string, port ...int) (adbClient Client, err error)
  • func (c Client) Connect(ip string, port ...int) (err error)
  • func (c Client) DeviceList() (devices []Device, err error)
  • func (c Client) DeviceSerialList() (serials []string, err error)
  • func (c Client) Disconnect(ip string, port ...int) (err error)
  • func (c Client) DisconnectAll() (err error)
  • func (c Client) ForwardKillAll() (err error)
  • func (c Client) ForwardList() (deviceForward []DeviceForward, err error)
  • func (c Client) KillServer() (err error)
  • func (c Client) ServerVersion() (version int, err error)
• type Device
  • func (d Device) DeviceInfo() map[string]string
  • func (d Device) DevicePath() (string, error)
  • func (d Device) EnableAdbOverTCP(port ...int) (err error)
  • func (d Device) Forward(localPort, remotePort int, noRebind ...bool) (err error)
  • func (d Device) ForwardKill(localPort int) (err error)
  • func (d Device) ForwardList() (deviceForwardList []DeviceForward, err error)
  • func (d Device) IsUsb() bool
  • func (d Device) List(remotePath string) (devFileInfos []DeviceFileInfo, err error)
  • func (d Device) Model() string
  • func (d Device) Product() string
  • func (d Device) Pull(remotePath string, dest io.Writer) (err error)
  • func (d Device) Push(source io.Reader, remotePath string, modification time.Time, ...) (err error)
  • func (d Device) PushFile(local *os.File, remotePath string, modification ...time.Time) (err error)
  • func (d Device) RunShellCommand(cmd string, args ...string) (string, error)
  • func (d Device) RunShellCommandWithBytes(cmd string, args ...string) ([]byte, error)
  • func (d Device) Serial() string
  • func (d Device) State() (DeviceState, error)
  • func (d Device) Usb() string
• type DeviceFileInfo
  • func (info DeviceFileInfo) IsDir() bool
• type DeviceForward
• type DeviceState

Constants

const AdbDaemonPort = 5555

const AdbServerPort = 5037

const DefaultFileMode = os.FileMode(0664)

Variables

var DefaultAdbReadTimeout time.Duration = 60

var ErrConnBroken = errors.New("socket connection broken")

Functions

func SetDebug

func SetDebug(debug bool)

SetDebug set debug mode

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient() (Client, error)

func NewClientWith

func NewClientWith(host string, port ...int) (adbClient Client, err error)

func (Client) Connect

func (c Client) Connect(ip string, port ...int) (err error)

func (Client) DeviceList

func (c Client) DeviceList() (devices []Device, err error)

func (Client) DeviceSerialList

func (c Client) DeviceSerialList() (serials []string, err error)

func (Client) Disconnect

func (c Client) Disconnect(ip string, port ...int) (err error)

func (Client) DisconnectAll

func (c Client) DisconnectAll() (err error)

func (Client) ForwardKillAll

func (c Client) ForwardKillAll() (err error)

func (Client) ForwardList

func (c Client) ForwardList() (deviceForward []DeviceForward, err error)

func (Client) KillServer

func (c Client) KillServer() (err error)

func (Client) ServerVersion

func (c Client) ServerVersion() (version int, err error)

type Device

type Device struct {
	// contains filtered or unexported fields
}

func (Device) DeviceInfo

func (d Device) DeviceInfo() map[string]string

func (Device) DevicePath

func (d Device) DevicePath() (string, error)

func (Device) EnableAdbOverTCP

func (d Device) EnableAdbOverTCP(port ...int) (err error)

func (Device) Forward

func (d Device) Forward(localPort, remotePort int, noRebind ...bool) (err error)

func (Device) ForwardKill

func (d Device) ForwardKill(localPort int) (err error)

func (Device) ForwardList

func (d Device) ForwardList() (deviceForwardList []DeviceForward, err error)

func (Device) IsUsb

func (d Device) IsUsb() bool

func (Device) List

func (d Device) List(remotePath string) (devFileInfos []DeviceFileInfo, err error)

func (Device) Model

func (d Device) Model() string

func (Device) Product

func (d Device) Product() string

func (Device) Pull

func (d Device) Pull(remotePath string, dest io.Writer) (err error)

func (Device) Push

func (d Device) Push(source io.Reader, remotePath string, modification time.Time, mode ...os.FileMode) (err error)

func (Device) PushFile

func (d Device) PushFile(local *os.File, remotePath string, modification ...time.Time) (err error)

func (Device) RunShellCommand

func (d Device) RunShellCommand(cmd string, args ...string) (string, error)

func (Device) RunShellCommandWithBytes

func (d Device) RunShellCommandWithBytes(cmd string, args ...string) ([]byte, error)

func (Device) Serial

func (d Device) Serial() string

func (Device) State

func (d Device) State() (DeviceState, error)

func (Device) Usb

func (d Device) Usb() string

type DeviceFileInfo

type DeviceFileInfo struct {
	Name         string
	Mode         os.FileMode
	Size         uint32
	LastModified time.Time
}

func (DeviceFileInfo) IsDir

func (info DeviceFileInfo) IsDir() bool

type DeviceForward

type DeviceForward struct {
	Serial string
	Local  string
	Remote string
}

type DeviceState

type DeviceState string

const (
	StateUnknown      DeviceState = "UNKNOWN"
	StateOnline       DeviceState = "online"
	StateOffline      DeviceState = "offline"
	StateDisconnected DeviceState = "disconnected"
)