appetizer-toolkit

appetizer-toolkit is the core of Appetizer, which provides the ability to:

• record touchscreen events from one device and replay to many (aspect ratios must be the same)
• control multiple devices concurrently (e.g., run a shell command, install an app, etc.)
• mirror the touchscreen events from one device to many in real time (aspect ratios must be the same)

appetizer-toolkit is a command line tool, available on Windows 7+, MacOS Mavericks+ and Linux. It also comes with SDK for Python and Nodejs. appetizer-toolkit requires adb to be present in PATH.

Please submit issues for bug reports, enhancements and feature requests. Pull requests are welcomed too.

Installation

The executable file can be found in the darwin/ for macOS, win32/ for Windows and linux/ for Ubuntu, Fedora and Centos. You might want to add to PATH to use the tool globally. Linux and macOS build are both 64-bit and Windows build is 32-bit (compatible with 64-bit as WOW)

usage: appetizer [-h] {version,trace,adb,devices,plan} ...

positional arguments:
  {version,trace,adb,devices,plan}
                        commands
    version             Print the version information and exit
    trace               Record and replay touchscreen events
    adb                 Control the local ADB
    devices             Command devices
    plan                Compose and execute a test plan file

optional arguments:
  -h, --help            show this help message and exit

Record and Replay

To record and replay touchscreen events, use appetizer trace:

usage: appetizer trace [-h] {info,replay,record} ...

positional arguments:
  {info,replay,record}  actions
    info                Get the detail of a trace file
    replay              Replay a touchscreen event trace to some devices
    record              Record a trace of touchscreen events

optional arguments:
  -h, --help            show this help message and exit

Control Multiple Devices and Mirror Touchscreen Events

To work with multiple devices, use appetizer devices:

usage: appetizer devices [-h]
                                           {list,screenshot,mirror,control}
                                           ...

positional arguments:
  {list,screenshot,mirror,control}
                        actions on the devices
    list                List the details of connected devices
    screenshot          Take a screenshot
    mirror              Mirror the touchscreen events from one device to many
                        in real-time
    control             Control devices

optional arguments:
  -h, --help            show this help message and exit

Mirror the touchscreen events from one device to many in real-time.

ADB related

adb from Android SDK is required for appetizer-toolkit. The toolkit itself can detect the existence of the adb binary and control the adb server with it.

usage: appetizer adb [-h]
                                       
                                       {check-server,start-server,kill-server,detectadb}
                                       ...

positional arguments:
  {check-server,start-server,kill-server,detectadb}
                        actions on the adb server
    check-server        Check the state of the adb server
    start-server        Start the adb server
    kill-server         Kill the adb server
    detectadb           Detect the path to the adb program

optional arguments:
  -h, --help            show this help message and exit