@browserless/cli 10.9.17 → 10.10.0

package/README.md

@@ -1,14 +1,18 @@
 <div align="center">
-  <br>
   <img style="width: 500px; margin:3rem 0 1.5rem;" src="https://github.com/microlinkhq/browserless/raw/master/static/logo-banner.png#gh-light-mode-only" alt="browserless">
   <img style="width: 500px; margin:3rem 0 1.5rem;" src="https://github.com/microlinkhq/browserless/raw/master/static/logo-banner-light.png#gh-dark-mode-only" alt="browserless">
-  <br>
-  <br>
-  <p align="center"><strong>@browserless/cli</strong>: CLI to interact with Browserless capabilities.</p>
-  <p align="center">See <a href="https://browserless.js.org/#%2F%3Fid=command-line-interface" target='_blank' rel='noopener noreferrer'>CLI</a> section our <a href="https://browserless.js.org" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
-  <br>
+  <br><br>
+  <a href="https://microlink.io"><img src="https://img.shields.io/badge/powered_by-microlink.io-blue?style=flat-square&color=%23EA407B" alt="Powered by microlink.io"></a>
+  <img src="https://img.shields.io/github/tag/microlinkhq/browserless.svg?style=flat-square" alt="Last version">
+  <a href="https://coveralls.io/github/microlinkhq/browserless"><img src="https://img.shields.io/coveralls/microlinkhq/browserless.svg?style=flat-square" alt="Coverage Status"></a>
+  <a href="https://www.npmjs.org/package/browserless"><img src="https://img.shields.io/npm/dm/browserless.svg?style=flat-square" alt="NPM Status"></a>
+  <br><br>
 </div>
 
+> @browserless/cli: CLI to interact with Browserless capabilities.
+
+See [CLI section](https://browserless.js.org/#/?id=cli) our website for more information.
+
 ## Install
 
 Using npm:
@@ -17,6 +21,50 @@ Using npm:
 npm install @browserless/cli -g
 ```
 
+## About
+
+This package provides a **command-line interface** for interacting with browserless capabilities directly from your terminal. It exposes the `browserless` binary that wraps the core browserless API into easy-to-use shell commands.
+
+### What this package does
+
+The `@browserless/cli` package allows you to:
+
+- **Take screenshots** from URLs with gradient backgrounds, browser overlays, and device emulation
+- **Generate PDFs** from web pages
+- **Extract content** as HTML or plain text
+- **Run Lighthouse audits** for performance analysis
+- **Analyze page weight** (network requests, transfer size, resource size)
+- **Check URL status** and response information (redirects, headers, status codes)
+
+### Available commands
+
+| Command | Description |
+|---------|-------------|
+| `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 |
+| `text <url>` | Extract plain text content from the page |
+| `lighthouse <url>` | Run a Google Lighthouse audit and output JSON report |
+| `page-weight <url>` | Analyze network requests and resource sizes |
+| `ping <url>` | Get response info: status code, redirects, headers |
+| `status <url>` | Get the HTTP status code |
+| `goto <url>` | Navigate to a URL and return page/response info |
+
+> **Note:** The `lighthouse` command requires an extra installation.  
+> 
+> Please make sure to install the standalone package by running:<br>
+> <kbd>npm install -g @browserless/lighthouse</kbd>
+
+### How it fits in the monorepo
+This package depends on:
+
+| Dependency                | Purpose                                                 |
+|---------------------------|---------------------------------------------------------|
+| browserless               | Core API for all browser automation operations          |
+| @browserless/lighthouse   | Lighthouse audit integration (used by lighthouse command) |
+
+The CLI acts as a thin wrapper that parses command-line arguments, initializes a browserless instance, and delegates to the appropriate command handler.
+
 ## License
 
 **@browserless/cli** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/browserless/blob/master/LICENSE.md) License.<br>

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@browserless/cli",
-  "description": "CLI to interact with Browserless capabilities",
+  "description": "Command-line interface for headless browser automation. Take screenshots, generate PDFs, and extract content from websites.",
   "homepage": "https://browserless.js.org",
-  "version": "10.9.17",
+  "version": "10.10.0",
   "bin": {
     "browserless": "src/index.js"
   },
@@ -20,25 +20,27 @@
     "url": "https://github.com/microlinkhq/browserless/issues"
   },
   "keywords": [
-    "browser",
     "browserless",
-    "chrome",
-    "chromeless",
     "cli",
-    "example",
-    "examples",
+    "command-line",
     "headless",
-    "puppeteer"
+    "chrome",
+    "puppeteer",
+    "screenshot",
+    "pdf",
+    "automation",
+    "web-scraping",
+    "terminal",
+    "tool"
   ],
   "dependencies": {
     "beauty-error": "~1.2.21",
-    "browserless": "^10.9.17",
+    "browserless": "^10.10.0",
     "dark-mode": "~3.0.0",
     "dset": "~3.1.4",
     "mri": "~1.2.0",
     "nanospinner": "~1.2.2",
     "nestie": "~1.0.3",
-    "picocolors": "~1.1.1",
     "pretty-bytes": "~5.6.0",
     "process-stats": "~3.7.16",
     "restore-cursor": "~3.1.0",
@@ -57,5 +59,5 @@
     "test": "exit 0"
   },
   "license": "MIT",
-  "gitHead": "9a7d4769776621dc6cf886698591924049530bb6"
+  "gitHead": "9b80e677418f2defb804d39043680fe65e3e277b"
 }

package/src/colors.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const { styleText } = require('node:util')
+
+const gray = str => styleText('gray', str)
+
+const white = str => styleText('white', str)
+
+const green = str => styleText('green', str)
+
+const red = str => styleText('red', str)
+
+const yellow = str => styleText('yellow', str)
+
+const label = (text, color) => styleText(['inverse', 'bold', color], ` ${text.toUpperCase()} `)
+
+module.exports = { gray, white, green, red, yellow, label }

package/src/commands/lighthouse.js

@@ -1,6 +1,19 @@
 'use strict'
 
-const createLighthouse = require('../../../lighthouse/src')
+const { existsSync } = require('fs')
+const { resolve } = require('path')
+
+const lighthousePath = resolve(__dirname, '../../../lighthouse/src')
+
+let createLighthouse
+
+if (existsSync(lighthousePath)) {
+  createLighthouse = require(lighthousePath)
+} else {
+  console.error('The @browserless/lighthouse package is not installed.')
+  console.error('Please install it by running: npm install -g @browserless/lighthouse')
+  process.exit(1)
+}
 
 module.exports = async ({ url, browserless, opts }) => {
   const lighthouse = createLighthouse(async teardown => {

package/src/commands/screenshot.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const uniqueRandomArray = require('unique-random-array')
-const { gray, yellow } = require('picocolors')
+const { gray, yellow } = require('../colors')
 const darkMode = require('dark-mode')
 const termImg = require('term-img')
 const { dset } = require('dset')

package/src/help.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { gray } = require('picocolors')
+const { gray } = require('./colors')
 const { EOL } = require('os')
 const path = require('path')
 

package/src/spinner.js

@@ -3,7 +3,7 @@
 const createProcStats = require('process-stats')
 const { createSpinner } = require('nanospinner')
 const prettyBytes = require('pretty-bytes')
-const { gray } = require('picocolors')
+const { gray } = require('./colors')
 
 const TICK_INTERVAL = 50
 const procStats = createProcStats({ tick: TICK_INTERVAL })