emulator

README

emu

A small yet handy CLI program to make working with Android emulators a bit more pleasant.

Windows isn't currently supported.

Install

macOS

brew tap bartekpacia/tools
brew install emu

ArchLinux

TBD

Features

• Easily list and run emulators
• Full shell completion for all commands, flags, and emulator names
• Change font size and display size
• Toggle dark mode
• bonus: doesn't butcher your AirPods sound quality!

Documentation

Overview

Package emulator provides common functionality to manage Android emulators.

Index

• Variables
• func CreateAVD(osimage SystemImage, skin string, sdcardMB int) (string, string, error)
• func DeleteAVD(avdName string) error
• func DisableAnimations() error
• func DisableDarkTheme() error
• func EnableAnimations() error
• func EnableDarkTheme() error
• func SetDisplaySize(value float32) error
• func SetFontSize(value string) error
• func Skins() ([]string, error)
• func Start(name string) error
• func ToggleAnimations() error
• func ToggleDarkTheme() error
• type AVD
  • func List() ([]AVD, error)
  • func (a AVD) Describe() string
• type SystemImage
  • func SystemImages() ([]SystemImage, error)
  • func (s SystemImage) ApiLevel() string

Variables

var PrintInvocations bool

PrintInvocations controls whether to print invocations of subprocesses.

var Serial string

Serial is the serial port of the running AVD, for example "emulator-5554".

Functions

func CreateAVD

func CreateAVD(osimage SystemImage, skin string, sdcardMB int) (string, string, error)

CreateAVD creates a new Android Virtual Device and returns its name and path.

It wraps the avdmanager tool from Android SDK.Example AVD manager invocation:

avdmanager create avd \
  --sdcard '8192M' \
  --package "system-images;android-34;google_apis_playstore;arm64-v8a" \
  --name "Pixel_7_API_34" \
  --device "pixel_7"

In addition, it also automatically enables keyboard input.

func DeleteAVD

func DeleteAVD(avdName string) error

func DisableAnimations

func DisableAnimations() error

func DisableDarkTheme

func DisableDarkTheme() error

func EnableAnimations

func EnableAnimations() error

func EnableDarkTheme

func EnableDarkTheme() error

func SetDisplaySize

func SetDisplaySize(value float32) error

func SetFontSize

func SetFontSize(value string) error

func Skins

func Skins() ([]string, error)

func Start

func Start(name string) error

Start starts the AVD with the given name.

func ToggleAnimations

func ToggleAnimations() error

func ToggleDarkTheme

func ToggleDarkTheme() error

Types

type AVD

type AVD struct {
	Name    string
	Running bool

	// PID of the emulator process. Equals 0 if Running is false.
	Pid int
}

AVD represents an Android Virtual Device.

It assumes that no 2 instances of the same AVD run at the same time.

func List

func List() ([]AVD, error)

List returns a list of available AVDs and whether they're running or not.

func (AVD) Describe

func (a AVD) Describe() string

type SystemImage

type SystemImage string

SystemImage is a unique identifier of an Android OS image .Examples:

• system-images;android-34;google_apis_playstore;arm64-v8a
• system-images;android-35;google_apis;x86_64

func SystemImages

func SystemImages() ([]SystemImage, error)

SystemImages returns installed Android system images.

func (SystemImage) ApiLevel

func (s SystemImage) ApiLevel() string

ApiLevel returns the API level of this system image. Error can be returned when e.g. the new Android version still has only a codename, not a number.