> ## Documentation Index
> Fetch the complete documentation index at: https://momentic.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# appium

> Execute an Appium script against the device.

Executes an Appium script against the device. There is no simplified form.
`script` is required.

## Parameters

| Parameter | Type      | Required | Description                                                 |
| --------- | --------- | -------- | ----------------------------------------------------------- |
| `script`  | `string`  | Yes      | The Appium script to execute.                               |
| `args`    | `string`  | No       | Arguments passed to the script.                             |
| `saveAs`  | `string`  | No       | Variable to store this step's return value on `env.<name>`. |
| `retries` | `number`  | No       | Times to retry the step on failure before failing the test. |
| `skipped` | `boolean` | No       | Skip this step at execution time.                           |

## Examples

```yaml theme={null}
- appium:
    script: "mobile: shell"
    args: '{ "command": "echo", "args": ["hi"] }' # JSON args passed to the script
```

## Related

* [Test format](/core-concepts/test-format)
* [adb](/reference/mobile-commands/adb)