Appium Clients

You need a client to write and run Appium scripts. You'll want to become very familiar with your client documentation (as well as the documentation of any Selenium client that the Appium client depends on) since that will be your primary interface to Appium.

To learn more about clients, check out the Client Intro.

Note

If you maintain an Appium client that you would like to be listed here, feel free to create a PR!

Official Clients¶

These clients are currently maintained by the Appium team:

Java Client ¶

Language: Java

=== "Setup With Maven"

```xml
<dependency>
  <groupId>io.appium</groupId>
  <artifactId>java-client</artifactId>
  <version>${version.you.require}</version>
  <scope>test</scope>
</dependency>
```

=== "Setup With Gradle"

```groovy
dependencies {
  testImplementation 'io.appium:java-client:${version.you.require}'
}
```

Python Client ¶

Language: Python

Install From PyPi

pip install Appium-Python-Client

Ruby Core Client ¶

Language: Ruby

Install From RubyGems

gem install appium_lib_core

Ruby Client ¶

Language: Ruby

This client is a wrapper for the Ruby Core Client with several helper methods, though this may add additional complexity, therefore the Ruby Core Client is recommended instead.

Install From RubyGems

gem install appium_lib

.NET Client ¶

Language: C#

Install Using .NET CLI

dotnet add package Appium.WebDriver

Other Clients¶

These clients are not maintained by the Appium team and can be used with other languages.

In general, any W3C WebDriver spec-compatible client will also integrate well with Appium, though some Appium-specific commands may not be implemented in other clients.

WebdriverIO ¶

Language: JavaScript/TypeScript

Setup Using npm

npm init wdio@latest .

Nightwatch.js ¶

Language: JavaScript/TypeScript

=== "Setup For Android"

```sh
npx @nightwatch/mobile-helper android --appium
```

=== "Setup For iOS"

```sh
npx @nightwatch/mobile-helper ios --appium
```

RobotFramework AppiumLibrary ¶

Language: Robot Framework

Install From PyPi

pip install robotframework-appiumlibrary

multicatch's appium-client ¶

Language: Rust

Install Using Cargo

cargo add appium-client

SwiftAppium ¶

Language: Swift

Install and Setup

git clone https://github.com/milcgroup/SwiftAppium.git
cd SwiftAppium
swift build
swift run swiftappium