@oya-ai/cli 1.0.110 → 1.0.112

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -15
  2. package/dist/index.js +892 -461
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -66,19 +66,28 @@ oya rm --all
66
66
 
67
67
  ---
68
68
 
69
+ ## Scripting: `--json` and exit codes
70
+
71
+ - `--json` puts exactly one JSON document on stdout. Prompts and progress go to stderr.
72
+ - A failure prints one line on stderr (`✗ message`, then a hint), or with `--json` one object: `{"error", "code", "status"}`.
73
+ - Exit codes: `0` done, `1` the request failed or got no answer, `2` the command could not be run as typed and nothing was sent.
74
+ - An unknown flag is an error, not ignored. `--flag=value` works as well as `--flag value`.
75
+ - `--debug` (or `OYA_DEBUG=1`) adds the status, the response body and the stack to a failure.
76
+ - `oya install`, `oya init` and `oya stealth-test` are for people and refuse `--json`.
77
+
69
78
  ## 📖 Command Reference
70
79
 
71
80
  ### Fleet Execution & Control
72
81
 
73
- | Command | Flags | Description |
74
- |:---|:---|:---|
75
- | `oya start` | `[--persona <id\|auto>] [--provider <p>] [--name <n>] [--governed] [--budget-usd <n>]` | Launch browser instance and print its ID and CDP endpoint |
76
- | `oya goto <url>` | `[--id <id>]` | Navigate to URL (defaults to newest browser) |
77
- | `oya ask "<prompt>"` | `[--id <id>]` | Drive page using configured AI model |
78
- | `oya open` | `[--id <id>]` | Launch interactive SSE live view in system browser |
79
- | `oya ls` | `[--json]` | List active fleet browsers with health status |
80
- | `oya status` | `[--id <id>] [--json]` | Detailed metrics, error counts, and recent activity log |
81
- | `oya rm <id>...` | `[--all]` | Terminate target browser or entire fleet |
82
+ | Command | Flags | Description |
83
+ | :------------------- | :------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
84
+ | `oya start` | `[--persona <id\|auto>] [--provider <p>] [--name <n>] [--governed] [--budget-usd <n>]` | Launch browser instance and print its ID and CDP endpoint |
85
+ | `oya goto <url>` | `[--id <id>]` | Navigate to URL (defaults to newest browser) |
86
+ | `oya ask "<prompt>"` | `[--id <id>]` | Drive page using configured AI model |
87
+ | `oya open` | `[--id <id>]` | Launch interactive SSE live view in system browser |
88
+ | `oya ls` | `[--json]` | List active fleet browsers with health status |
89
+ | `oya status` | `[--id <id>] [--json]` | Detailed metrics, error counts, and recent activity log |
90
+ | `oya rm <id>...` | `[--all]` | Terminate target browser or entire fleet |
82
91
 
83
92
  ### Persona Management (Anti-Ban Identities)
84
93
 
@@ -189,12 +198,12 @@ export OYA_BASE_URL="https://oyabrowser.com"
189
198
  oya start --provider browserbase --persona auto --json
190
199
  ```
191
200
 
192
- | Global Flag | Description |
193
- |:---|:---|
194
- | `--key <key>` | Override API key for command |
195
- | `--url <url>` | Override control plane URL |
196
- | `--id <id>` | Target specific browser instance ID |
197
- | `--json` | Output pure JSON for programmatic parsing |
201
+ | Global Flag | Description |
202
+ | :------------ | :---------------------------------------- |
203
+ | `--key <key>` | Override API key for command |
204
+ | `--url <url>` | Override control plane URL |
205
+ | `--id <id>` | Target specific browser instance ID |
206
+ | `--json` | Output pure JSON for programmatic parsing |
198
207
 
199
208
  ---
200
209