This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Push File

Place a file onto the device in a particular place

Example Usage

driver.pushFile("/data/local/tmp/foo.bar", new File("/Users/johndoe/files/foo.bar"));

dest_path = '/data/local/tmp/test_push_file.txt'
data = bytes('This is the contents of the file to push to the device.', 'utf-8')
self.driver.push_file(dest_path, base64.b64encode(data).decode('utf-8'))

// webdriver.io example
let data = Buffer.from("Hello World").toString('base64');
driver.pushFile('/data/local/tmp/file.txt', data);

// wd example
await driver.pushFileToDevice('/data/local/tmp/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');

# ruby_lib example
push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))

# ruby_lib_core example
@driver.push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))

driver.PushFile("/data/local/tmp/foo.bar", new FileInfo("/Users/johndoe/files/foo.bar"))

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python All appium.github.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
C# All github.com

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/device/push_file

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
path string Path to install the data to
data string Contents of file in base64

Response

null

See Also