Appium Desktop is an open source app for Mac, Windows, and Linux which allows you to use Appium Server in a intuitive and powerful GUI as compared to the command line Appium tool.

You can install it from here - Github Appium Desktop Repository


Appium Inspector is a component of the Appium Desktop application that allows us to inspect mobile Apps.


On opening the Appium Desktop Client, it will look as shown below:



Steps to start using Appium Desktop:

1. Starting the local Appium Server


The Default values for Host IP is 0.0.0.0 and Port number is 4723.

Note: It is highly recommended to keep the Port number unchanged unless you are a System Administrator since other port numbers might be used by another Application.


You can click on the Start Server button to start the Server. Your Appium Server will start running and it will look as shown below:



The default endpoint for Appium is of the form, http://<host>:<port>/wd/hub. For example, http://0.0.0.0:4723/wd/hub in this case.

Once the Appium Server has started, you can use the above Appium Endpoint for automating your Tests.


You have three options now:

  • Start Inspector Session - Start a new Inspector session and attach it to the already running Appium Server.
  • Get Raw Logs - Get the logs in a Text file
  • Stop Server - Stop the the currently running Appium Server.


Now let us check how to start an Inspector session to inspect a mobile App.


2. Starting a new Appium Inspector Session


Click on the Start Inspector Session to open the Inspector Session Configuration page. Since we have already started Appium Server, the default option is to attach the new Inspector session to the already running Appium Server. You may start a Custom Server using the Custom Server tab, or other Endpoints such as Sauce Labs tab if you want to run tests on a Cloud Device.


Desired Capabilities

There are a set of bare minimum Desired Capabilities we need to add in order to inspect an Android/iOS App using the Inspector.


Desired Capabilities for Android

  • platformName: We need to provide the value 'Android'.
  • platformVersion: As per the version of your Android Device/Simulator.
  • deviceName: Providing a deviceName is optional.
  • appPackage: Package name of the app to be automated.
  • appActivity: Name of the Activity of the App we need to start with.


Here's a sample set:

{
  "platformName": "Android",
  "platformVersion": "8.1",
  "deviceName": "Redmi 5 Pro",
  "appPackage": "org.wikipedia",
  "appActivity": ".main.MainActivity"
}


Desired Capabilities for iOS

  • platformName: We need to provide the value 'iOS'.
  • platformVersion: As per the version of your iOS Device/Simulator.
  • deviceName: Providing a deviceName is optional.
  • app: Path to the app to be automated.
  • udid: UDID of the device.
  • bundleID: Bundle ID of the app to be automated.


Here's a sample set:

{
  platformName: "iOS",
  platformVersion: "12.0",
  deviceName: "iPhone X",
  app: "~/Documents/TestApp.ipa",
  udid: "12345678-ABCD-DEFG-AVBFJDSKFL"
}



Enter the above given Desired Capabilities in the Appium Inspector Session Configuration window as shown below:



Finally, click on Start Session to start the session and inspect the Apps using Appium Inspector.



Thus, we have successfully started a local Appium Server and Appium Inspector session for inspecting your Mobile App.

Happy Automation!