soufatn / appium-dot-app

An OS X GUI for Appium

To install:

1. Download the latest version from appium.io
2. Mount the disk-image
3. Drag Appium.app to your Applications folder

Parameter Guide

Main Window

IP Address: the IP addres on which you want the appium server to run (127.0.0.1 is localhost)
Port: the port on which the appium server will listen for WebDriver commands (4723 is the default)
Use Remote Server Checkbox: Used to connect Appium Inpector to a server that is already running. (only appears in Developer Mode)
Inspector (i) Button: launches the Appium Inspector
Launch / Stop Button: launches or stops the Appium server
App Path: the path to the iOS application (.app,.zip, or.ipa) or Android application (.apk) you wish to test. When the checkbox is checked this will be provided to the server so that all connections will boot this application. You only need to supply a path here if you are using the pre-launch preference or if you do not want to supply it as part of the capabilities object when you connect.
Choose Button: used to choose the path to your application
Clear Button: clears the display of all log data

iOS Tab

UDID: this is the UDID for the mobile device on which you want to run Appium. If this box is checked, Appium will use the attached ios device. If this field is checked, bundle ID must be supplied and app path should be unchecked.
BundleID: the bundle ID for the application you wish Appium to use (e.g. com.yourCompany.yourApp)
Force Device: this will tell Appium to force the simulator to iPhone or iPad mode
Use Mobile Safari: this will have Appium boot the Mobile Safari app instead of using a user-supplied application. BundleID or App Path should both be unchecked when this option is used.

Android Tab

Package: Android Package you wish to use
Activity: Android Activity you wish to launch with
Launch AVD: Selected AVD will be launched using the Android Emulator.
Wait For Activity: Android Activity you wish Appium to wait for upon launch.

Preference Guide

Preferences can be accessed by Going to Appium > Preferences or with the keyboard shortcut (COMMAND + ,)

Check For Updates: Appium will automatically check for updates upon boot.
Quiet Logging: Appium will log out limited information.
Keep Artifactes: Appium will keep artifacts like .trace files around after a session has ended.
Reset Application State After Each Session: Appium will reset application state (e.g. delete user plists) after each session.
Prelaunch Application: Appium will prelaunch the application before beginning to listen for WebDriver commands
Developer Mode: will enable additional settings targeted at Appium project developers.

iOS Settings

Use Native Instruments Lib: Appium will not use the "Instruments Without Delay" plugin. (commands will be very slow)
Force Orientation: Appium will rotate the device to Portrait or Landscape.

Android Settings

Full Reset: a full reset will be performed before launching the server. This includes uninstalling the .apk under test.
Device Ready Timeout: This is the maximum amount of time in seconds Appium will wait for a connected Android device to be ready.

Developer Settings

Use External NodeJS Binary: Appium will use the version of NodeJS supplied here instead of the one that ships with the application.
Use External Appium Package: Appium will use the version of the appium package supplied here instead of the one bundled with the application.
NodeJS Debug Port: Port on which the NodeJS debugger will run.
Break on Application Start: The nodeJS debug server will break at the application start. (equivalent to supplying the debug-brk switch to node)

Inspector / Recorder

Inspector can be accessed by clicking the blue "i" next to the launch button once the Appium server has launched. Appium must be running with an app open for inspector to work. Otherwise, it will not work.

Inspector Window

Show Invisible Filter: Elements which are not visible will be displayed in the DOM 3-column-view.
Show Disabled Filter: Elements which are not enabled will be displayed in the DOM 3-column-view.
Record Button: Opens the recording Panel and starts recording actions performed using controls in the Appium.
Inspector.
Refresh Button: Refreshes the DOM 3-column view and the screenshot.
Screenshot Area: Displays the last screenshot taken for the app. You can click this area to select elements in the DOM.
Details Area: Displays details about the currently selected element.

Action Palette

The action pallete contains buttons that will trigger actions on the device under test. You can try out actions here or enter them to be recorded.

Touch Section: Contains buttons to perform touch events like tapping and swiping.
Text Section: Contains buttons to perform text events like typing and executing javascript.
Alerts Section: Contains buttons to perform events on alerts and actionsheets.

Recorder Drawer

The recorder draw contains the code generated by recorded actions you've performed while recording is enabled.

Language Selection Dropdown: Changes the language your recorded actions are displayed in.
Add Boilerplate Checkbox: Checking this block will display code used to setup the Selenium instance along with code related to the actions you have recorded. Unchecking this box will only show only the code from the actions you have recorded.
XPath Only Checkbox: Checking this will cause all element identifiers to be created using XPath.
Replay Button: Replays the actions that you have recorded.
Undo Button: Deletes the last recorded action.
Redo Button: Adds back the last undone action.
Clear Button: Removes all recorded actions.