appium.io Open in urlscan Pro
2606:4700::6810:9b0c  Public Scan

URL: https://appium.io/docs/en/2.4/
Submission: On February 02 via api from GB — Scanned from GB

Form analysis 3 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="M7.5 2c-1.79 1.15-3 3.18-3 5.5s1.21 4.35 3.03 5.5C4.46 13 2 10.54 2 7.5A5.5 5.5 0 0 1 7.5 2m11.57 1.5 1.43 1.43L4.93 20.5 3.5 19.07 19.07 3.5m-6.18 2.43L11.41 5 9.97 6l.42-1.7L9 3.24l1.75-.12.58-1.65L12 3.1l1.73.03-1.35 1.13.51 1.67m-3.3 3.61-1.16-.73-1.12.78.34-1.32-1.09-.83 1.36-.09.45-1.29.51 1.27 1.36.03-1.05.87.4 1.31M19 13.5a5.5 5.5 0 0 1-5.5 5.5c-1.22 0-2.35-.4-3.26-1.07l7.69-7.69c.67.91 1.07 2.04 1.07 3.26m-4.4 6.58 2.77-1.15-.24 3.35-2.53-2.2m4.33-2.7 1.15-2.77 2.2 2.54-3.35.23m1.15-4.96-1.14-2.78 3.34.24-2.2 2.54M9.63 18.93l2.77 1.15-2.53 2.19-.24-3.34Z">
      </path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette"
    id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z">
      </path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette"
    id="__palette_2">
  <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z">
      </path>
    </svg>
  </label>
</form>

Name: search

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
</form>

Name: consent

<form class="md-consent__form md-grid md-typeset" name="consent">
  <h4>Cookie consent</h4>
  <p>We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation
    better.</p>
  <input class="md-toggle" type="checkbox" id="__settings">
  <div class="md-consent__settings">
    <ul class="task-list">
      <li class="task-list-item">
        <label class="task-list-control">
          <input type="checkbox" name="github" checked="">
          <span class="task-list-indicator"></span> GitHub </label>
      </li>
    </ul>
  </div>
  <div class="md-consent__controls">
    <button class="md-button md-button--primary">Accept</button>
    <button type="reset" class="md-button md-button--primary">Reject</button>
    <label class="md-button" for="__settings">Manage settings</label>
  </div>
</form>

Text Content

Skip to content


Appium Documentation
2.4
 * 2.4
 * 2.3
 * 2.2
 * 2.1
 * 2.0

Welcome

 * English
 * 日本
 * 中文简体

Type to start searching
appium/appium
 * Welcome
 * Introduction
 * Quickstart
 * Ecosystem
 * CLI Reference
 * Command Reference
 * Guides
 * More Resources
 * Developing
 * Contributing

Appium Documentation
appium/appium
 * Welcome Welcome
   Table of contents
    * Explore the Documentation

 * Introduction
   Introduction
    * Appium in a Nutshell
    * Background
      Background
       * How Does Appium Work?
       * Intro to Appium Drivers
       * Intro to Appium Clients
       * Appium Project History

 * Quickstart
   Quickstart
    * Quickstart Intro
    * System Requirements
    * Install Appium
    * Install the UiAutomator2 Driver
    * Write a Test
      Write a Test
       * Write a Test (JS)
       * Write a Test (Python)
       * Write a Test (Java)
       * Write a Test (Ruby)
       * Write a Test (.NET)
   
    * Next Steps

 * Ecosystem
   Ecosystem
    * Ecosystem Overview
    * Appium Drivers
    * Appium Clients
    * Appium Plugins
    * Appium-Related Tools

 * CLI Reference
   CLI Reference
    * Command-Line Overview
    * Server Command-Line Arguments
    * Server Environment Variables
    * Extension Command-Line Usage

 * Command Reference
   Command Reference
    * Intro to Commands
    * Driver: base-driver
    * Plugin: execute-driver
    * Plugin: images
    * Plugin: relaxed-caps
    * Plugin: universal-xml

 * Guides
   Guides
    * Migration
      Migration
       * Migrating to Appium 2
   
    * Server/Driver Configuration
      Server/Driver Configuration
       * Managing Drivers and Plugins
       * The Appium Config File
       * Appium Server Security
       * Filtering the Appium Log
       * Appium and Selenium Grid
       * Caching of Application Bundles
       * SSL/TLS/SPDY Support
   
    * Session Configuration
      Session Configuration
       * Session Capabilities
       * Session Settings
       * Execute Methods
       * Managing Contexts
       * Retrieving Event Timings

 * More Resources
 * Developing
   Developing
    * Intro to Development
    * Building Drivers
    * Building Plugins
    * Building Documentation
    * Building Doctor Checks

 * Contributing
   Contributing
    * Contributing to Appium
    * Contributing Code
    * Appium's Config System

Table of contents
 * Explore the Documentation


WELCOME



Welcome to the Appium documentation! Appium is an open-source project and
ecosystem of related software, designed to facilitate UI automation of many app
platforms, including mobile (iOS, Android, Tizen), browser (Chrome, Firefox,
Safari), desktop (macOS, Windows), TV (Roku, tvOS, Android TV, Samsung), and
more!


EXPLORE THE DOCUMENTATION¶

 * Check out the Introduction to make sure you understand the key concepts
 * Go through the Quickstart to get set up and run a basic Android test
 * Visit the Ecosystem page for a list of drivers, clients and plugins you may
   want to use
 * Refer to the CLI Reference for using Appium from the command line
 * See the Command Reference for a list of commands exposed by Appium and
   plugins
 * Read the different Guides for a variety of instructions, tips and tricks
 * Check out various third-party Resources to explore Appium around the web
 * For creating your own Appium extensions, see the Developer documentation
 * For contributions to Appium itself, refer to the Contributing page

1 month ago2023-12-16
Back to top
Copyright © 2012 OpenJS Foundation - Change cookie settings
Made with Material for MkDocs



COOKIE CONSENT

We use cookies to recognize your repeated visits and preferences, as well as to
measure the effectiveness of our documentation and whether users find what
they're searching for. With your consent, you're helping us to make our
documentation better.

 * GitHub

Accept Reject Manage settings