Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: subcommand workflows #69

Merged
merged 8 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/subcommands/connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Workflows of the `connect` subcommand

**Syntax**
```sh
npx @nightwatch/mobile-helper android connect [flags|cliConfigs]
garg3133 marked this conversation as resolved.
Show resolved Hide resolved
```

### 1. Connect a real device wirelessly

> Note: Only devices with Android version 11 or higher are supported.

Run the below command to connect to a real device wirelessly:
```sh
npx @nightwatch/mobile-helper android connect --wireless
```
30 changes: 30 additions & 0 deletions docs/subcommands/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Workflows of the `install` subcommand

**Syntax**
```sh
npx @nightwatch/mobile-helper android install [flags|cliConfigs]
garg3133 marked this conversation as resolved.
Show resolved Hide resolved
```

### 1. Install an APK

Run the below command to install an APK on a real device or an AVD:

```sh
npx @nightwatch/mobile-helper android install --app

# with configs
npx @nightwatch/mobile-helper android install --app [--deviceId <device_id>] [--path <path_to_apk>]
garg3133 marked this conversation as resolved.
Show resolved Hide resolved

**Configs**

| Config | Description |
| ------------------------------ | -------------------------------------------------------------- |
| --deviceId \| -s <device_id> | Id of the device to install the APK |
| --path \| -p <path_to_apk> | Path to the APK file relative to the current working directory |

### 2. Create a new Android Virtual Device

Run the below command to create a new AVD:
```sh
npx @nightwatch/mobile-helper android install --avd
```
21 changes: 21 additions & 0 deletions docs/subcommands/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Workflows of the `list` subcommand

**Syntax**
```sh
npx @nightwatch/mobile-helper android list [flags]
```

### 1. Show a list of connected devices

Run the below command to show a list of all the connected real devices and running AVDs:
```sh
npx @nightwatch/mobile-helper android list --device
```

### 2. Show a list of installed AVDs

Run the below command to show a list of all the currently installed AVDs
```sh
npx @nightwatch/mobile-helper android list --avd
```

14 changes: 14 additions & 0 deletions docs/subcommands/uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Workflows of the `uninstall` subcommand

**Syntax**
```sh
npx @nightwatch/mobile-helper android uninstall [flags|cliConfigs]
garg3133 marked this conversation as resolved.
Show resolved Hide resolved
```

### 1. Delete an Android Virtual Device

Run the below command to delete a currently present AVD:
garg3133 marked this conversation as resolved.
Show resolved Hide resolved
```sh
npx @nightwatch/mobile-helper android uninstall --avd
```

Loading