diff --git a/README.md b/README.md index 1bb7564..ee08a25 100644 --- a/README.md +++ b/README.md @@ -130,6 +130,7 @@ Commands with JSON output support: - **Deploy**: `deploy` (JSONL streaming), `history` - **Invoke**: `invoke` (JSONL streaming), `history` - **Browser Sub-commands**: `replays list/start`, `process exec/spawn`, `fs file-info/list-files` +- **Browser NDJSON streaming**: `telemetry stream` ### Authentication @@ -212,6 +213,9 @@ Commands with JSON output support: - `--start-url ` - Initial page to open on launch - `--pool-id ` - Acquire a browser from the specified pool (mutually exclusive with --pool-name; ignores other session flags) - `--pool-name ` - Acquire a browser from the pool name (mutually exclusive with --pool-id; ignores other session flags) + - `--telemetry=all` - Enable telemetry for all categories + - `--telemetry=off` - Disable telemetry + - `--telemetry=` - Per-category config, e.g. `--telemetry=network=on,page=off` - `--output json`, `-o json` - Output raw JSON object - _Note: When a pool is specified, omit other session configuration flags—pool settings determine profile, proxy, viewport, etc._ - `kernel browsers delete ` - Delete a browser @@ -219,6 +223,11 @@ Commands with JSON output support: - `--output json`, `-o json` - Output JSON with liveViewUrl - `kernel browsers get ` - Get detailed browser session info - `--output json`, `-o json` - Output raw JSON object +- `kernel browsers update ` - Update a running browser session + - `--telemetry=all` - Enable telemetry for all categories + - `--telemetry=off` - Disable telemetry + - `--telemetry=` - Per-category config, e.g. `--telemetry=network=on,page=off` + - `--output json`, `-o json` - Output raw JSON object - `kernel browsers curl ` - Make HTTP requests through a browser session's Chrome network stack - `-X, --request ` - HTTP method (default: GET; defaults to POST when `--data` is set) - `-H, --header
` - HTTP header, repeatable (`"Key: Value"` format) @@ -281,6 +290,23 @@ Commands with JSON output support: - `kernel browsers replays download ` - Download a replay video - `-f, --output-file ` - Output file path for the replay video +### Browser Telemetry + +Telemetry config is a sub-field of the browser session. Use `browsers create` or `browsers update` to enable, disable, or configure it, and `browsers get` to inspect the current state. + +- Enable all categories: `kernel browsers update --telemetry=all` +- Disable: `kernel browsers update --telemetry=off` +- Per-category: `kernel browsers update --telemetry=network=on,page=off` (valid: `console`, `interaction`, `network`, `page`; `system` always emits and cannot be toggled) + +Per-category updates are partial — only categories you name are changed; others retain their current state. `--telemetry=all` and `--telemetry=off` reset the entire config. + +- `kernel browsers telemetry stream ` - Stream live telemetry events (NDJSON with `-o json`) + - `--categories ` - Filter by event category (`console`, `network`, `page`, `interaction`, `system`); `system` matches `monitor_*` event types + - `--types ` - Filter by event type (e.g. `network_response`, `console_error`) + - `--seq ` - Resume from sequence number (Last-Event-ID); `--seq=0` replays from the beginning. Omit to stream from now. + - `-o, --output json` - Output newline-delimited JSON envelopes + - Default output: tab-separated `