Skip to content

Commit b3c243c

Browse files
committed
Merge branch 'main' into sayan/kernel-569-browser-pools-cli-integration
2 parents 8249362 + 5d277a1 commit b3c243c

File tree

3 files changed

+99
-99
lines changed

3 files changed

+99
-99
lines changed

README.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -149,16 +149,15 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
149149

150150
- `kernel browsers list` - List running browsers
151151
- `kernel browsers create` - Create a new browser session
152-
- `-p, --persistence-id <id>` - Unique identifier for browser session persistence
153152
- `-s, --stealth` - Launch browser in stealth mode to avoid detection
154153
- `-H, --headless` - Launch browser without GUI access
155154
- `--kiosk` - Launch browser in kiosk mode
156155
- `--pool-id <id>` - Acquire a browser from the specified pool (mutually exclusive with --pool-name; ignores other session flags)
157156
- `--pool-name <name>` - Acquire a browser from the pool name (mutually exclusive with --pool-id; ignores other session flags)
158157
- _Note: When a pool is specified, omit other session configuration flags—pool settings determine profile, proxy, viewport, etc._
159-
- `kernel browsers delete <id or persistent id>` - Delete a browser
158+
- `kernel browsers delete <id>` - Delete a browser
160159
- `-y, --yes` - Skip confirmation prompt
161-
- `kernel browsers view <id or persistent id>` - Get live view URL for a browser
160+
- `kernel browsers view <id>` - Get live view URL for a browser
162161

163162
### Browser Pools
164163

@@ -182,135 +181,135 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
182181

183182
### Browser Logs
184183

185-
- `kernel browsers logs stream <id or persistent id>` - Stream browser logs
184+
- `kernel browsers logs stream <id>` - Stream browser logs
186185
- `--source <source>` - Log source: "path" or "supervisor" (required)
187186
- `--follow` - Follow the log stream (default: true)
188187
- `--path <path>` - File path when source=path
189188
- `--supervisor-process <name>` - Supervisor process name when source=supervisor. Most useful value is "chromium"
190189

191190
### Browser Replays
192191

193-
- `kernel browsers replays list <id or persistent id>` - List replays for a browser
194-
- `kernel browsers replays start <id or persistent id>` - Start a replay recording
192+
- `kernel browsers replays list <id>` - List replays for a browser
193+
- `kernel browsers replays start <id>` - Start a replay recording
195194
- `--framerate <fps>` - Recording framerate (fps)
196195
- `--max-duration <seconds>` - Maximum duration in seconds
197-
- `kernel browsers replays stop <id or persistent id> <replay-id>` - Stop a replay recording
198-
- `kernel browsers replays download <id or persistent id> <replay-id>` - Download a replay video
196+
- `kernel browsers replays stop <id> <replay-id>` - Stop a replay recording
197+
- `kernel browsers replays download <id> <replay-id>` - Download a replay video
199198
- `-o, --output <path>` - Output file path for the replay video
200199

201200
### Browser Process Control
202201

203-
- `kernel browsers process exec <id or persistent id> [--] [command...]` - Execute a command synchronously
202+
- `kernel browsers process exec <id> [--] [command...]` - Execute a command synchronously
204203
- `--command <cmd>` - Command to execute (optional; if omitted, trailing args are executed via /bin/bash -c)
205204
- `--args <args>` - Command arguments
206205
- `--cwd <path>` - Working directory
207206
- `--timeout <seconds>` - Timeout in seconds
208207
- `--as-user <user>` - Run as user
209208
- `--as-root` - Run as root
210-
- `kernel browsers process spawn <id or persistent id> [--] [command...]` - Execute a command asynchronously
209+
- `kernel browsers process spawn <id> [--] [command...]` - Execute a command asynchronously
211210
- `--command <cmd>` - Command to execute (optional; if omitted, trailing args are executed via /bin/bash -c)
212211
- `--args <args>` - Command arguments
213212
- `--cwd <path>` - Working directory
214213
- `--timeout <seconds>` - Timeout in seconds
215214
- `--as-user <user>` - Run as user
216215
- `--as-root` - Run as root
217-
- `kernel browsers process kill <id or persistent id> <process-id>` - Send a signal to a process
216+
- `kernel browsers process kill <id> <process-id>` - Send a signal to a process
218217
- `--signal <signal>` - Signal to send: TERM, KILL, INT, HUP (default: TERM)
219-
- `kernel browsers process status <id or persistent id> <process-id>` - Get process status
220-
- `kernel browsers process stdin <id or persistent id> <process-id>` - Write to process stdin (base64)
218+
- `kernel browsers process status <id> <process-id>` - Get process status
219+
- `kernel browsers process stdin <id> <process-id>` - Write to process stdin (base64)
221220
- `--data-b64 <data>` - Base64-encoded data to write to stdin (required)
222-
- `kernel browsers process stdout-stream <id or persistent id> <process-id>` - Stream process stdout/stderr
221+
- `kernel browsers process stdout-stream <id> <process-id>` - Stream process stdout/stderr
223222

224223
### Browser Filesystem
225224

226-
- `kernel browsers fs new-directory <id or persistent id>` - Create a new directory
225+
- `kernel browsers fs new-directory <id>` - Create a new directory
227226
- `--path <path>` - Absolute directory path to create (required)
228227
- `--mode <mode>` - Directory mode (octal string)
229-
- `kernel browsers fs delete-directory <id or persistent id>` - Delete a directory
228+
- `kernel browsers fs delete-directory <id>` - Delete a directory
230229
- `--path <path>` - Absolute directory path to delete (required)
231-
- `kernel browsers fs delete-file <id or persistent id>` - Delete a file
230+
- `kernel browsers fs delete-file <id>` - Delete a file
232231
- `--path <path>` - Absolute file path to delete (required)
233-
- `kernel browsers fs download-dir-zip <id or persistent id>` - Download a directory as zip
232+
- `kernel browsers fs download-dir-zip <id>` - Download a directory as zip
234233
- `--path <path>` - Absolute directory path to download (required)
235234
- `-o, --output <path>` - Output zip file path
236-
- `kernel browsers fs file-info <id or persistent id>` - Get file or directory info
235+
- `kernel browsers fs file-info <id>` - Get file or directory info
237236
- `--path <path>` - Absolute file or directory path (required)
238-
- `kernel browsers fs list-files <id or persistent id>` - List files in a directory
237+
- `kernel browsers fs list-files <id>` - List files in a directory
239238
- `--path <path>` - Absolute directory path (required)
240-
- `kernel browsers fs move <id or persistent id>` - Move or rename a file or directory
239+
- `kernel browsers fs move <id>` - Move or rename a file or directory
241240
- `--src <path>` - Absolute source path (required)
242241
- `--dest <path>` - Absolute destination path (required)
243-
- `kernel browsers fs read-file <id or persistent id>` - Read a file
242+
- `kernel browsers fs read-file <id>` - Read a file
244243
- `--path <path>` - Absolute file path (required)
245244
- `-o, --output <path>` - Output file path (optional)
246-
- `kernel browsers fs set-permissions <id or persistent id>` - Set file permissions or ownership
245+
- `kernel browsers fs set-permissions <id>` - Set file permissions or ownership
247246
- `--path <path>` - Absolute path (required)
248247
- `--mode <mode>` - File mode bits (octal string) (required)
249248
- `--owner <user>` - New owner username or UID
250249
- `--group <group>` - New group name or GID
251-
- `kernel browsers fs upload <id or persistent id>` - Upload one or more files
250+
- `kernel browsers fs upload <id>` - Upload one or more files
252251
- `--file <local:remote>` - Mapping local:remote (repeatable)
253252
- `--dest-dir <path>` - Destination directory for uploads
254253
- `--paths <paths>` - Local file paths to upload
255-
- `kernel browsers fs upload-zip <id or persistent id>` - Upload a zip and extract it
254+
- `kernel browsers fs upload-zip <id>` - Upload a zip and extract it
256255
- `--zip <path>` - Local zip file path (required)
257256
- `--dest-dir <path>` - Destination directory to extract to (required)
258-
- `kernel browsers fs write-file <id or persistent id>` - Write a file from local data
257+
- `kernel browsers fs write-file <id>` - Write a file from local data
259258
- `--path <path>` - Destination absolute file path (required)
260259
- `--mode <mode>` - File mode (octal string)
261260
- `--source <path>` - Local source file path (required)
262261

263262
### Browser Extensions
264263

265-
- `kernel browsers extensions upload <id or persistent id> <extension-path>...` - Ad-hoc upload of one or more unpacked extensions to a running browser instance.
264+
- `kernel browsers extensions upload <id> <extension-path>...` - Ad-hoc upload of one or more unpacked extensions to a running browser instance.
266265

267266
### Browser Computer Controls
268267

269-
- `kernel browsers computer click-mouse <id or persistent id>` - Click mouse at coordinates
268+
- `kernel browsers computer click-mouse <id>` - Click mouse at coordinates
270269
- `--x <coordinate>` - X coordinate (required)
271270
- `--y <coordinate>` - Y coordinate (required)
272271
- `--num-clicks <n>` - Number of clicks (default: 1)
273272
- `--button <button>` - Mouse button: left, right, middle, back, forward (default: left)
274273
- `--click-type <type>` - Click type: down, up, click (default: click)
275274
- `--hold-key <key>` - Modifier keys to hold (repeatable)
276-
- `kernel browsers computer move-mouse <id or persistent id>` - Move mouse to coordinates
275+
- `kernel browsers computer move-mouse <id>` - Move mouse to coordinates
277276
- `--x <coordinate>` - X coordinate (required)
278277
- `--y <coordinate>` - Y coordinate (required)
279278
- `--hold-key <key>` - Modifier keys to hold (repeatable)
280-
- `kernel browsers computer screenshot <id or persistent id>` - Capture a screenshot
279+
- `kernel browsers computer screenshot <id>` - Capture a screenshot
281280
- `--to <path>` - Output file path for the PNG image (required)
282281
- `--x <coordinate>` - Top-left X for region capture (optional)
283282
- `--y <coordinate>` - Top-left Y for region capture (optional)
284283
- `--width <pixels>` - Region width (optional)
285284
- `--height <pixels>` - Region height (optional)
286-
- `kernel browsers computer type <id or persistent id>` - Type text on the browser instance
285+
- `kernel browsers computer type <id>` - Type text on the browser instance
287286

288287
- `--text <text>` - Text to type (required)
289288
- `--delay <ms>` - Delay in milliseconds between keystrokes (optional)
290289

291-
- `kernel browsers computer press-key <id or persistent id>` - Press one or more keys
290+
- `kernel browsers computer press-key <id>` - Press one or more keys
292291

293292
- `--key <key>` - Key symbols to press (repeatable)
294293
- `--duration <ms>` - Duration to hold keys down in ms (0=tap)
295294
- `--hold-key <key>` - Modifier keys to hold (repeatable)
296295

297-
- `kernel browsers computer scroll <id or persistent id>` - Scroll the mouse wheel
296+
- `kernel browsers computer scroll <id>` - Scroll the mouse wheel
298297

299298
- `--x <coordinate>` - X coordinate (required)
300299
- `--y <coordinate>` - Y coordinate (required)
301300
- `--delta-x <pixels>` - Horizontal scroll amount (+right, -left)
302301
- `--delta-y <pixels>` - Vertical scroll amount (+down, -up)
303302
- `--hold-key <key>` - Modifier keys to hold (repeatable)
304303

305-
- `kernel browsers computer drag-mouse <id or persistent id>` - Drag the mouse along a path
304+
- `kernel browsers computer drag-mouse <id>` - Drag the mouse along a path
306305
- `--point <x,y>` - Add a point as x,y (repeatable)
307306
- `--delay <ms>` - Delay before dragging starts in ms
308307
- `--button <button>` - Mouse button: left, middle, right (default: left)
309308
- `--hold-key <key>` - Modifier keys to hold (repeatable)
310309

311310
### Browser Playwright
312311

313-
- `kernel browsers playwright execute <id or persistent id> [code]` - Execute Playwright/TypeScript code against the browser
312+
- `kernel browsers playwright execute <id> [code]` - Execute Playwright/TypeScript code against the browser
314313
- `--timeout <seconds>` - Maximum execution time in seconds (defaults server-side)
315314
- If `[code]` is omitted, code is read from stdin
316315

@@ -398,20 +397,23 @@ kernel browsers list
398397
# Create a new browser session
399398
kernel browsers create
400399

401-
# Create a persistent browser session
402-
kernel browsers create --persistence-id my-browser-session
400+
# Create a browser with a longer timeout (up to 72 hours)
401+
kernel browsers create --timeout 3600
403402

404403
# Create a headless browser in stealth mode
405404
kernel browsers create --headless --stealth
406405

407406
# Create a browser in kiosk mode
408407
kernel browsers create --kiosk
409408

410-
# Delete a persistent browser
411-
kernel browsers delete --by-persistent-id my-browser-session --yes
409+
# Create a browser with a profile for session state
410+
kernel browsers create --profile-name my-profile
411+
412+
# Delete a browser
413+
kernel browsers delete browser123 --yes
412414

413415
# Get live view URL
414-
kernel browsers view --by-id browser123
416+
kernel browsers view browser123
415417

416418
# Stream browser logs
417419
kernel browsers logs stream my-browser --source supervisor --follow --supervisor-process chromium

0 commit comments

Comments
 (0)