@browserless/cli 10.10.2 → 10.11.0

package/README.md

@@ -30,6 +30,7 @@ This package provides a **command-line interface** for interacting with browserl
 The `@browserless/cli` package allows you to:
 
 - **Take screenshots** from URLs with gradient backgrounds, browser overlays, and device emulation
+- **Record captures** as video/audio using the `tabCapture` extension flow
 - **Generate PDFs** from web pages
 - **Extract content** as HTML or plain text
 - **Run Lighthouse audits** for performance analysis
@@ -40,6 +41,7 @@ The `@browserless/cli` package allows you to:
 
 | Command | Description |
 |---------|-------------|
+| `capture <url>` | Record a page and return video buffer (use `--path` to save file) |
 | `screenshot <url>` | Capture a screenshot with optional overlay and background |
 | `pdf <url>` | Generate a PDF document from a web page |
 | `html <url>` | Serialize the page content to HTML |
@@ -50,6 +52,16 @@ The `@browserless/cli` package allows you to:
 | `status <url>` | Get the HTTP status code |
 | `goto <url>` | Navigate to a URL and return page/response info |
 
+### Capture examples
+
+```sh
+# webm (default)
+browserless capture https://example.com --path=./capture.webm
+
+# mp4 using friendly output type
+browserless capture https://example.com --type=mp4 --path=./capture.mp4
+```
+
 > **Note:** The `lighthouse` command requires an extra installation.  
 > 
 > Please make sure to install the standalone package by running:<br>
@@ -60,6 +72,7 @@ This package depends on:
 
 | Dependency                | Purpose                                                 |
 |---------------------------|---------------------------------------------------------|
+| @browserless/capture      | Extension-based tab capture for CLI video recording     |
 | browserless               | Core API for all browser automation operations          |
 | @browserless/lighthouse   | Lighthouse audit integration (used by lighthouse command) |
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/cli",
   "description": "Command-line interface for headless browser automation. Take screenshots, generate PDFs, and extract content from websites.",
   "homepage": "https://browserless.js.org",
-  "version": "10.10.2",
+  "version": "10.11.0",
   "bin": {
     "browserless": "src/index.js"
   },
@@ -34,8 +34,9 @@
     "tool"
   ],
   "dependencies": {
+    "@browserless/capture": "^10.11.0",
     "beauty-error": "~1.2.21",
-    "browserless": "^10.10.2",
+    "browserless": "^10.11.0",
     "dark-mode": "~3.0.0",
     "dset": "~3.1.4",
     "mri": "~1.2.0",
@@ -54,10 +55,9 @@
   "files": [
     "src"
   ],
+  "license": "MIT",
   "scripts": {
     "coverage": "exit 0",
     "test": "exit 0"
-  },
-  "license": "MIT",
-  "gitHead": "ec6a614923a1a692bd717ecc8e6f1b09417801d9"
-}
+  }
+}

package/src/commands/capture.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const prettyBytes = require('pretty-bytes')
+
+module.exports = async ({ url, browserless, opts }) => {
+  const { path: outputPath, ...captureOpts } = opts
+
+  const type = captureOpts.type && String(captureOpts.type).toLowerCase()
+
+  const suggestedType =
+    { matroska: 'mkv', mkv: 'mkv', mp4: 'mp4', webm: 'webm' }[type] ||
+    (captureOpts.mimeType && captureOpts.mimeType.includes('mp4') ? 'mp4' : 'webm')
+
+  const video = await browserless.capture(url, {
+    ...captureOpts,
+    path: outputPath
+  })
+
+  const preview = outputPath
+    ? `saved at ${process.cwd()}/${outputPath}`
+    : `captured ${prettyBytes(video.length)} (use --path=./capture.${suggestedType} to persist)`
+
+  return [video, preview]
+}

package/src/index.js

@@ -63,7 +63,13 @@ const run = async () => {
   const [command, rawUrl] = cli.input
   const url = new URL(rawUrl).toString()
   const fn = require(`./commands/${command}`)
-  const browser = createBrowser({ headless })
+  const launchOpts = { headless }
+
+  if (command === 'capture') {
+    launchOpts.headless = headless === false ? false : 'new'
+  }
+
+  const browser = createBrowser(launchOpts)
   onExit(browser.close)
   const browserless = await browser.createContext()
   return fn({ url, browserless, opts: nestie(opts), isPageReady })