appium/commands-yml/commands/device/app/install-app.yml

Automation for Apps.

---
name: Install App
short_description: Install the given app onto the device
description:
  >
    iOS tests with XCUITest can also use the `mobile: installApp` method. See
    detailed [documentation](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-installapp).

example_usage:
  java:
    |
      driver.installApp("/Users/johndoe/path/to/app.apk");
  python:
    |
      self.driver.install_app('/Users/johndoe/path/to/app.apk');
  javascript_wd:
    |
      await driver.installAppOnDevice('/Users/johndoe/path/to/app.apk');
  javascript_wdio:
    |
      driver.installApp('/Users/johndoe/path/to/app.apk')
  ruby:
    |
      @driver.install_app('/Users/johndoe/path/to/app.apk')
  php:
    |
      $driver->installApp('/Users/johndoe/path/to/app.apk');
  csharp:
    |
      // TODO C# sample

client_docs:
  java: "http://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#installApp-java.lang.String-"
  python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L554"
  javascript_wdio: "http://webdriver.io/api/mobile/installApp.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2540"
  ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#install_app-instance_method"
  php: "https://github.com/appium/php-client/" # TODO PHP documentation link
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# Driver support by platform
driver_support:
  ios:
    xcuitest: true
    uiautomation: true
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: false # TODO: Verify this
  windows:
    windows: false # TODO: Verify this
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true


# Information about the HTTP endpoints
endpoint:
  url: /wd/hub/session/:session_id/device/install_app
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: appPath
      type: string
      description: Path of the app being installed

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L372