You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 846850a
Browse filesBrowse the repository at this point in the historyBrowse files
docs(revyl): show the plugin call a reader can paste
The setup example named `startAgentDevice({ revyl: ... })`, which is not the API:
the plugin is passed in `plugins` and the client is built from the returned scope.
Both calls are spelled out now, next to what the CLI does for the same profile.
`device-clouds.md` compares Revyl in the same columns as the other clouds, and the
versioned CLI help names it beside the other provider profiles.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Copy file name to clipboardExpand all lines: src/commands/schema/cli-help.ts
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -550,7 +550,7 @@ After direct-provider connect:
550
550
Do not run devices as a pre-open catalog probe for direct providers; it can allocate the deferred provider session. Limrun is the exception for apps: before allocation it lists uploaded assets for the selected platform.
551
551
552
552
Device cloud interfaces:
553
-
CLI is the canonical bootstrap path: connect limrun/browserstack/aws-device-farm/testmu/revyl, then use normal open/snapshot/click/close/artifacts/disconnect commands.
553
+
CLI is the canonical bootstrap path: connect limrun/browserstack/aws-device-farm/testmu/revyl, then use normal open/snapshot/click/close/disconnect commands; artifacts are provider-dependent.
554
554
JavaScript can skip persisted connect state by passing leaseProvider plus provider fields to createAgentDeviceClient or per-command options.
555
555
MCP exposes operational tools such as open, snapshot, click, close, and artifacts. It does not expose connect/disconnect; run CLI connect first in the same state dir before relying on MCP tools.
556
556
@@ -659,9 +659,9 @@ Rules:
659
659
Use connect without --remote-config when the cloud control plane owns the connection profile.
660
660
Prefer connect --remote-config over --daemon-base-url, --tenant, --run-id, and --lease-id when using a local profile.
661
661
Use agent-device proxy for direct tunnel access to a Mac you control. Expose the printed proxy URL through cloudflared/ngrok, then run agent-device connect proxy with the tunnel URL and printed token before normal commands.
662
-
Use Limrun, BrowserStack, AWS Device Farm, and TestMu AI through local provider profiles; they do not accept a remote agent-device daemon URL.
662
+
Use Limrun, BrowserStack, AWS Device Farm, TestMu AI, and Revyl through local provider profiles; they do not accept a remote agent-device daemon URL.
663
663
Device cloud credentials must be available before the command starts. Limrun uses LIMRUN_API_KEY, or the LIM_*_INSTANCE_* variables for an existing instance. BrowserStack uses BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY. TestMu AI uses LT_USERNAME and LT_ACCESS_KEY. Revyl uses REVYL_API_KEY, with REVYL_API_URL to point at another Revyl backend. AWS Device Farm uses the AWS CLI credential chain, including CI-provided AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY/AWS_SESSION_TOKEN, AWS profiles, or web identity role variables.
664
-
A local daemon keeps the Limrun, BrowserStack, and TestMu AI credentials it started with. When the shell holds different ones, the first command that allocates a lease refuses with reason provider-credentials-changed; run agent-device daemon stop with the same --state-dir, then rerun the command. A shell that sets none of them uses the daemon's. A daemon with an HTTP auth hook serves remote callers and does not compare.
664
+
A local daemon keeps the Limrun, BrowserStack, TestMu AI, and Revyl credentials it started with. When the shell holds different ones, the first command that allocates a lease refuses with reason provider-credentials-changed; run agent-device daemon stop with the same --state-dir, then rerun the command. A shell that sets none of them uses the daemon's. A daemon with an HTTP auth hook serves remote callers and does not compare.
665
665
A lease for a provider the daemon has no runtime for refuses with UNSUPPORTED_OPERATION, reason provider-not-registered, and lists the registered providers, plus the plugins that failed to register as failedPlugins; no lease is recorded. Restart the daemon with the provider configured. Provider-less leases, proxy, and cloud need no provider runtime.
666
666
Direct-provider connect performs read-only provider calls and saves active connection state only after verification succeeds. It never creates a device, instance, App Automate session, or AWS remote access session.
667
667
connect without --session always creates a fresh remote session and prints that session in its next-step commands. Concurrent callers must pass the returned --session on every command; the ambient active connection is only a single-workflow convenience.
| Devices | Android and iOS real devices | Android and iOS real devices | Android emulators and iOS simulators by default; real devices with `--provider-device-type real`| Android emulators and iOS simulators |
19
-
| Ships as | Built in | Built in; needs the AWS CLI | The `@agent-device/testmu` plugin | Built in |
20
-
| Credentials |`BROWSERSTACK_USERNAME`, `BROWSERSTACK_ACCESS_KEY`| The AWS CLI credential chain, such as `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`, `AWS_REGION`|`LT_USERNAME`, `LT_ACCESS_KEY`|`LIMRUN_API_KEY` (optional `LIMRUN_REGION`), or `LIM_*_INSTANCE_*` for an existing instance |
21
-
| Device allocated on |`open`|`open`|`open`| First device command, such as `install` or `open`|
22
-
| App source |`--provider-app`: `bs://` reference, HTTP(S) URL, or local path |`--aws-app-arn` upload ARN; no install after allocation |`--provider-app`: `lt://` reference, HTTP(S) URL, or local path |`install <id> <path-or-url>`, or `open <asset-name>` for an uploaded asset |
23
-
| Artifacts after `close`| Video, Appium and device logs, dashboard and public links | Video and log files, once AWS finalizes them | Video, Appium, device, network, and command logs, screenshots, dashboard link | None |
24
-
| Port reverse | No; use BrowserStack Local | No | No | Android over ADB; not on iOS |
25
-
| Live `network dump`| No; the provider owns the network path | No; the provider owns the network path | No; the provider owns the network path | Yes |
| Devices | Android and iOS real devices | Android and iOS real devices | Android emulators and iOS simulators by default; real devices with `--provider-device-type real`| Android emulators and iOS simulators | Android emulators and iOS simulators |
19
+
| Ships as | Built in | Built in; needs the AWS CLI | The `@agent-device/testmu` plugin | Built in | The `@agent-device/revyl` plugin |
20
+
| Credentials |`BROWSERSTACK_USERNAME`, `BROWSERSTACK_ACCESS_KEY`| The AWS CLI credential chain, such as `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`, `AWS_REGION`|`LT_USERNAME`, `LT_ACCESS_KEY`|`LIMRUN_API_KEY` (optional `LIMRUN_REGION`), or `LIM_*_INSTANCE_*` for an existing instance |`REVYL_API_KEY` (optional `REVYL_API_URL` for another Revyl backend) |
21
+
| Device allocated on |`open`|`open`|`open`| First device command, such as `install` or `open`| First device command, such as `open`|
22
+
| App source |`--provider-app`: `bs://` reference, HTTP(S) URL, or local path |`--aws-app-arn` upload ARN; no install after allocation |`--provider-app`: `lt://` reference, HTTP(S) URL, or local path |`install <id> <path-or-url>`, or `open <asset-name>` for an uploaded asset |`--provider-app`: a public HTTPS URL only, installed when the device starts |
23
+
| Artifacts after `close`| Video, Appium and device logs, dashboard and public links | Video and log files, once AWS finalizes them | Video, Appium, device, network, and command logs, screenshots, dashboard link | None | None |
24
+
| Port reverse | No; use BrowserStack Local | No | No | Android over ADB; not on iOS | No; publish the app server at a public URL |
25
+
| Live `network dump`| No; the provider owns the network path | No; the provider owns the network path | No; the provider owns the network path | Yes | No; the provider owns the network path |
26
26
27
27
## Shared workflow
28
28
29
-
Every provider runs through the local `agent-device` daemon. `connect` checks your credentials and configuration, then saves non-secret connection state; it does not allocate a device. BrowserStack, AWS Device Farm, and TestMu AI allocate a hosted session on `open`. Limrun allocates an instance on the first device command, such as `install` or `open`.
29
+
Every provider runs through the local `agent-device` daemon. `connect` checks your credentials and configuration, then saves non-secret connection state; it does not allocate a device. BrowserStack, AWS Device Farm, and TestMu AI allocate a hosted session on `open`. Limrun and Revyl allocate an instance on the first device command, such as `install` or `open`.
30
30
31
31
Every provider follows the same steps:
32
32
@@ -45,7 +45,7 @@ Run `agent-device connect <provider>` in the same effective state directory befo
45
45
46
46
## Change credentials while the daemon runs
47
47
48
-
A running daemon keeps the BrowserStack, TestMu AI, and Limrun credentials it started with. If your shell holds different ones, the first command that allocates a device, such as `open`, refuses before it creates a session. Run `agent-device daemon stop` with the same `--state-dir`, then rerun the command. A shell that sets none of the provider's variables uses the daemon's credentials.
48
+
A running daemon keeps the BrowserStack, TestMu AI, Limrun, and Revyl credentials it started with. If your shell holds different ones, the first command that allocates a device, such as `open`, refuses before it creates a session. Run `agent-device daemon stop` with the same `--state-dir`, then rerun the command. A shell that sets none of the provider's variables uses the daemon's credentials.
49
49
50
50
AWS Device Farm reads the AWS CLI credential chain instead, so this check does not apply to it.
0 commit comments