Skip to content

Getting Started

System Requirements

Installation requirements depend on the selected distribution format: standalone desktop app, or Appium server plugin.

  • Windows 10+, macOS 13+, Ubuntu 18.04+, Debian 10+, openSUSE 15.5+, or Fedora Linux 39+
  • Around 500MB of free space
  • Appium
  • Node.js ^20.19.0 || ^22.12.0 || >=24.0.0
  • Chrome/Edge/Firefox/Safari, released in 2022 or later
  • Around 9MB of free space

Make sure to use a plugin version that is compatible with your Appium server version. This only refers to the Appium versions under which the plugin can be installed, not the Appium versions on servers that the Inspector can connect to - see below for the latter.

Appium server version Compatible Inspector plugin versions
Appium 4 >= 2026.11.6
Appium 3 >= 2025.3.1
Appium 2 2025.3.1 - 2025.7.3

Appium Server Requirements

The Inspector cannot do much without an Appium server to connect to. Unless you only want to connect to existing Appium servers, you will need to install and set up a server of your own, which can be hosted either locally or remotely. For instructions on how to do this, please refer to the Appium documentation.

Not all major Appium versions are equally supported by all Inspector versions. While it is likely that the Inspector still supports basic creation of Appium 1 sessions, many application features do not work in such sessions. The following table lists the generally recommended Inspector app versions depending on your target Appium server version:

Target Appium server version Inspector versions with general support
Appium 4 >= 2026.11.5
Appium 3 >= 2025.3.1
Appium 2 >= 2021.8.5
Appium 1 <= 2024.12.1

If setting up your own server, make sure to also install the Appium driver(s) for your target platform(s). You can find links to all known drivers in the Appium documentation's Ecosystem page. Refer to each driver's documentation for its specific requirements and setup instructions.

Certain Inspector features may not work for older versions of certain drivers, so the following driver versions are recommended for best compatibility with the latest Inspector version:

Installation

Like with system requirements, the installation steps also differ depending on the selected distribution format.

Desktop App

The standalone Appium Inspector desktop application is published for Windows, macOS and Linux.

The app can either be downloaded manually, or installed through WinGet.

The app can be downloaded from the Inspector's GitHub repository: https://github.com/appium/appium-inspector/releases

Releases are published for x64 and arm64 platforms, in .exe and .zip formats. It is recommended to use the .exe installer file, as it supports checking for updates.

WinGet distribution is entirely community-supported, and is not maintained by the Appium team.

winget install AppiumDevelopers.AppiumInspector

The app can be downloaded from the Inspector's GitHub repository: https://github.com/appium/appium-inspector/releases

Releases are published for x64 and arm64 platforms, in .dmg and .zip formats. It is recommended to use the .dmg installer, as it supports checking for updates.

The app can be downloaded from the Inspector's GitHub repository: https://github.com/appium/appium-inspector/releases

Releases are published for x64 and arm64 platforms, in .AppImage files and .tar.gz formats. It is recommended to use the .AppImage file, as it supports checking for updates.

In order to open the .AppImage file, its executable flag needs to be set first:

chmod a+x Appium-Inspector-<version>-linux-<arch>.AppImage

Afterwards, the app can be opened through the command line:

./Appium-Inspector-<version>-linux-<arch>.AppImage

Appium Plugin

Like all Appium plugins, the Inspector plugin can be installed and activated using the Appium command line.

  1. Install the plugin:

    appium plugin install inspector
    
    # Appium 2 does not support the 'inspector' shortcut, and 2025.7.3 is its last compatible version
    appium plugin install --source=npm appium-inspector-plugin@2025.7.3
    
  2. Launch the Appium server with the plugin activated:

    appium --use-plugins=inspector --allow-insecure='*:cors'
    

    Appium 4 rejects state-changing requests sent from web pages unless CORS is enabled, which includes the Inspector page served by the plugin itself. See Troubleshooting.

    appium --use-plugins=inspector
    
  3. Open the Inspector URL in your web browser:

    http://127.0.0.1:4723/inspector
    

    Info

    Make sure the above host URL and port match those of the Appium server. The server's base path value is irrelevant, as the plugin always uses the /inspector path.

    Check the Troubleshooting guide if you are unable to create a session.

Creating a Session

Once the Inspector is installed and opened, the following screen should be shown:

Empty Session Builder

This is the Session Builder screen, where the server and session details must be specified.

Adding Server Details

Server Details

The server details section at the top of the window contains information about the Appium server, so that the Inspector knows how to connect to it:

  • If you wish to connect to a cloud provider service, select your vendor using the Select Cloud Providers button, switch to its tab, and fill in its required details.
  • If you wish to connect to a standalone local or remote Appium server, first make sure the server is launched and running. The start of the server log will have a list of IP addresses and ports that can be used to connect to the server.
    • For a local Appium server running on its default port, all server details fields can be left unchanged. By default, the Inspector will attempt to connect to http://127.0.0.1:4723, which matches the default values of the Appium server.
    • For a local or remote Appium server with non-default properties, please change the field values accordingly.

Adding Session Details

Session Details

The Capability Builder take up the majority of the Session Builder screen, and contains information about the session capabilities.

Warning

Appium has several mandatory capabilities (see above link). Attempting to start a new session without any capabilities will not work.

There are multiple ways to specify the session capabilities:

You may also want to consult the documentation of your target driver, which should provide a list of all its supported capabilities, as well as some basic examples.

Launching the Session

Here is an example image of a Session Builder with fully configured server and session information:

Full Session Builder

You can see the following details:

  • The server details are unchanged: the Inspector will try to connect to a local Appium server on its default port
  • The session capabilities specify the UiAutomator2 driver, with additional capabilities for the Android system settings app

Of course, your own server and session details will likely vary.

Clicking the Start Session button will send a new session request to the Appium server, and if successful, the Session Inspector screen should open:

Session Inspector

If this works, great! You can now start exploring your app using the various features described in the Session Inspector page.

If something went wrong, please check the Troubleshooting page for potential issues.