Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
38 changes: 8 additions & 30 deletions docs/kane-cli-cli-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,45 +57,24 @@ kane-cli run "<objective>" [options]
| Flag | Description | Default |
|------|-------------|---------|
| `--target <name>` | Which target to run against: `desktop`, `emulator`, or `simulator` | Saved session target, otherwise `desktop` |
| `--device-name <name>` | Pick a device as `kane-cli devices list --target emulator\|simulator` prints it. A name needs a version | Config value. When unset, a TTY run opens a one-time picker and saves the choice. Non-interactive runs require a device |
| `--os-version <version>` | The device's OS version, for example `14` or `17.5`. Alone, it matches any device on that version | Config value |
| `--device <id>` | Pick a device by name, serial, `ip:port`, or udid | TTY opens a one-time picker and saves the choice; non-interactive runs require it |
| `--app <path\|APPid>` | The app under test. A build (emulator `.apk`, simulator `.zip`) or an uploaded app id | Config value. Required for every mobile run |

On the `desktop` target, the device flags and `--app` are ignored. See [Mobile Testing](/docs/kane-cli-mobile/) for setup.
On the `desktop` target, `--device` and `--app` are ignored. See [Mobile Testing](/docs/kane-cli-mobile/) for setup.

---

### `kane-cli doctor`

Check the mobile tooling this machine needs for one target, `emulator` or `simulator`, and install the tooling Kane CLI manages for it. `--target` is required.
Check the mobile tooling on this machine, and install the tooling Kane CLI manages.

```bash
kane-cli doctor --target emulator # required checks, each with a fix if it fails
kane-cli doctor --target simulator --install # install the test tooling Kane CLI manages
kane-cli doctor # required checks, each with a fix if it fails
kane-cli doctor --install # install the test tooling Kane CLI manages
kane-cli doctor --targets # also list the emulators and simulators available
```

`doctor` prints one line per required check, each with a fix. Run `kane-cli login` before `--install`. See [Mobile Testing](/docs/kane-cli-mobile/).

---

### `kane-cli devices list`

List the emulators or simulators Kane CLI can run against. `--target` is required. Address a device on a run with `--device-name` and `--os-version` as the list prints them.

```bash
kane-cli devices list --target emulator # the emulators on this machine
kane-cli devices list --target simulator --remote # the simulators the cloud grid can provision
```

---

### `kane-cli apps list`

List the uploaded builds your account can use for a target. The **APP ID** column is what `--app` and `kane-cli config set-app` accept.

```bash
kane-cli apps list --target emulator
```
`doctor` prints one line per required check. Run `kane-cli login` before `--install`. See [Mobile Testing](/docs/kane-cli-mobile/).

---

Expand Down Expand Up @@ -173,8 +152,7 @@ kane-cli config chrome-profile [path] # Set Chrome profile (interactive pic
kane-cli config project [id] # Set Test Manager project (interactive picker if no id)
kane-cli config folder [id] # Set Test Manager folder (interactive picker if no id)
kane-cli config set-target <target> # Set run target: desktop | emulator | simulator
kane-cli config set-device-name <name> # Set default mobile device, as kane-cli devices list prints it
kane-cli config set-os-version <version> # Set the default mobile device's OS version
kane-cli config set-device <id> # Set default mobile device
kane-cli config set-app <path|APPid> # Set default app under test for mobile runs
```

Expand Down
18 changes: 8 additions & 10 deletions docs/kane-cli-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,8 @@ Empty fields are shown as `(none)`. The `chrome` path is empty by default, in wh
| `folder_id` | string \| null | `null` | <BrandName /> Test Manager folder ID for upload | `kane-cli config folder [id]` |
| `folder_name` | string \| null | `null` | Display name of the selected folder | Set by `kane-cli config folder` |
| `mode` | `"action"` \| `"testing"` | `"testing"` | Agent behaviour on auth walls, blocked pages, or error pages. | `kane-cli config set-mode <action\|testing>` |
| `target` | `"desktop"` \| `"emulator"` \| `"simulator"` | `"desktop"` | Default run target. `desktop` runs the Chrome browser, the default. `emulator` and `simulator` run against a virtual Android or iOS device on this machine (macOS Apple Silicon only). Other hosts use [`testrun run --remote`](/docs/kane-cli-mobile/#running-a-mobile-suite-on-the-cloud-grid). See [Mobile Target](#mobile-target). | `kane-cli config set-target <desktop\|emulator\|simulator>` |
| `device_name` | string \| null | `null` | Default mobile device, by the name `kane-cli devices list --target <kind>` prints. Pairs with `os_version`. When empty, a TTY run prompts once and saves the choice. A non-interactive run needs `--device-name` or this key set. Ignored on the `desktop` target. | `kane-cli config set-device-name <name>` |
| `os_version` | string \| null | `null` | OS version of the default mobile device (`14`, `17.5`). Required alongside `device_name`. | `kane-cli config set-os-version <version>` |
| `target` | `"desktop"` \| `"emulator"` \| `"simulator"` | `"desktop"` | Default run target. `desktop` runs the Chrome browser; `emulator` and `simulator` run against a virtual Android or iOS device (macOS Apple Silicon only). See [Mobile Target](#mobile-target). | `kane-cli config set-target <desktop\|emulator\|simulator>` |
| `device` | string \| null | `null` | Default mobile device, by name, serial, `ip:port`, or udid. When empty, a TTY run prompts once and saves the choice; a non-interactive run needs `--device` or this key set. Ignored on the `desktop` target. | `kane-cli config set-device <id>` |
| `app` | string \| null | `null` | Default app under test for mobile runs: a build path (`.apk` or `.zip`) or an uploaded app id. Ignored on the `desktop` target. | `kane-cli config set-app <path\|APPid>` |
| `bug_detection` | `"off"` \| `"stop"` \| `"continue"` | `"off"` | Whether the agent flags suspected product bugs while authoring. See [Bug detection](#bug-detection). | `kane-cli config set-bug-detection <mode>`, or per-run `--bug-detection` |
| `code_export.enabled` | boolean | `false` | Generate code export after upload completes. | TUI menu, or `--code-export` flag |
Expand Down Expand Up @@ -164,20 +163,19 @@ You can override the saved mode for a single run with `--mode <action|testing>`

### Mobile Target

On macOS Apple Silicon, Kane CLI can run against a virtual mobile device on this machine instead of the desktop browser. Four settings persist the default target and how to reach it. They are a **separate axis** from `mode` above: `mode` tunes agent behaviour, while these choose *what device* a run drives.
On macOS Apple Silicon, Kane CLI can run against a virtual mobile device instead of the desktop browser. Three settings persist the default target and how to reach it. They are a **separate axis** from `mode` above: `mode` tunes agent behaviour, while these choose *what device* a run drives.

```bash
kane-cli config set-target emulator # desktop | emulator | simulator
kane-cli config set-device-name "Pixel 7 API 35" # as `kane-cli devices list --target emulator` prints it
kane-cli config set-os-version 15
kane-cli config set-target emulator # desktop | emulator | simulator
kane-cli config set-device pixel-7 # name, serial, ip:port, or udid
kane-cli config set-app ./builds/app-debug.apk
```

- **`target`**: `desktop`, the default, runs Chrome. `emulator` runs a virtual Android device and `simulator` a virtual iOS device. Existing web runs are unaffected.
- **`device_name`** and **`os_version`**: the device a mobile run selects, in the vocabulary of `kane-cli devices list --target <kind>`. A name needs a version. A version alone matches any device on it. When unset, a TTY run prompts once and saves the choice. Non-interactive runs need them set, either here or with `--device-name` and `--os-version`.
- **`app`**: the app under test for a mobile run, a build path (emulator `.apk`, simulator `.zip`) or an uploaded app id, `APP` followed by six or more digits. Required for every mobile run. On the `desktop` target, the device keys and `app` are ignored.
- **`device`**: the device a mobile run selects, by name, serial, `ip:port`, or udid. When unset, a TTY run prompts once and saves the choice. Non-interactive runs need it set, either here or with `--device`.
- **`app`**: the app under test for a mobile run, a build path (emulator `.apk`, simulator `.zip`) or an uploaded app id, `APP` followed by six or more digits. Required for every mobile run. On the `desktop` target, `device` and `app` are ignored.

A run reads these as its defaults. Override any of them for a single run with `--target`, `--device-name`, `--os-version`, and `--app`. Setup and the full list of accepted app formats are in [Mobile Testing](/docs/kane-cli-mobile/). These defaults describe *local* devices. A [`testrun run --remote`](/docs/kane-cli-mobile/#running-a-mobile-suite-on-the-cloud-grid) run names its device from the grid catalog with the same two flags.
A run reads these as its defaults. Override any of them for a single run with `--target`, `--device`, and `--app`. Setup and the full list of accepted app formats are in [Mobile Testing](/docs/kane-cli-mobile/).

### Bug detection

Expand Down
97 changes: 0 additions & 97 deletions docs/kane-cli-mobile-emulator.mdx

This file was deleted.

81 changes: 0 additions & 81 deletions docs/kane-cli-mobile-simulator.mdx

This file was deleted.

Loading