# @browserless/cli 中文文档

规范地址：https://npmcn.com/package/%40browserless/cli/

版本：14\.1\.8
npm 元数据更新时间：2026-11-07T20:33:42.614Z
中文译文更新时间：2026-11-08T16:32:48.983Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40browserless/cli
原文对照：https://npmcn.com/package/%40browserless/cli/?lang=original
项目主页：https://browserless.js.org/
源码仓库：https://github.com/microlinkhq/browserless#master

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：22.7 kB，18 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>= 24
- 运行依赖：14 个
- 首次发布：2020-06-21T15:26:49.783Z
- 最新版本发布：2026-11-07T20:33:42.409Z
- 近 30 天下载量：4394（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：478（近 12 个月 129 个）

## 中文简介

无头浏览器自动化的命令行界面. 取出截图,生成PDF,并取出网站的内容.

## 安装

```sh
npm install @browserless/cli
```

也可以使用：`pnpm add @browserless/cli`、`yarn add @browserless/cli`、`bun add @browserless/cli`

## README

![browserless](https://github.com/microlinkhq/browserless/raw/master/static/logo-banner.png#gh-light-mode-only) ![browserless](https://github.com/microlinkhq/browserless/raw/master/static/logo-banner-light.png#gh-dark-mode-only)  
  
[![Powered by microlink.io](https://img.shields.io/badge/powered_by-microlink.io-blue?style=flat-square&color=%23EA407B)](https://microlink.io/) ![Last version](https://img.shields.io/github/tag/microlinkhq/browserless.svg?style=flat-square) [![Coverage Status](https://img.shields.io/coveralls/microlinkhq/browserless.svg?style=flat-square)](https://coveralls.io/github/microlinkhq/browserless) [![NPM Status](https://img.shields.io/npm/dm/browserless.svg?style=flat-square)](https://www.npmjs.org/package/browserless)  
  

> @browserless/cli:CLI与无浏览器能力交互.

见 [CLI 节](https://browserless.js.org/#/?id=cli) 我们的网站有更多信息.

## 安装

使用 npm :

```sh
npm install @browserless/cli -g
```

## 关于

此软件包提供了 **命令行接口** 用于直接从终端与无浏览器能力互动。 它揭露了 `browserless` 二进制将核心浏览器无API包成易用贝壳命令.

### 这个软件包做什么

这个 `@browserless/cli` 软件包允许您 :

-   **抓取截图** 从具有梯度背景的 URL,浏览器覆盖,以及设备仿真
-   **记录抓取** 视频/音频 `tabCapture` 扩展流量
-   **生成 PDF** 从网页
-   **摘录内容** 作为 HTML 或纯文本
-   **运行灯塔审计** 用于业绩分析
-   **分析页面重量** (网络请求、转移规模、资源规模)
-   **检查 URL 状态** 和反应信息(方向、标题、状态代码)

### 可用命令

| 命令 | 说明 |
| --- | --- |
| `capture <url>` | 记录一页并返回视频缓冲( 使用) `--path` 要保存文件) |
| `screenshot <url>` | 抓取带有可选覆盖和背景的截图 |
| `pdf <url>` | 从网页生成 PDF 文档 |
| `html <url>` | 将页面内容序列化为 HTML |
| `text <url>` | 从页面中提取纯文本内容 |
| `lighthouse <url>` | 运行 Google 灯塔审计并输出 JSON 报告 |
| `page-weight <url>` | 分析网络请求、资源大小和基本负载时间 |
| `ping <url>` | 获取响应信息: 状态代码、 方向、 信头 |
| `status <url>` | 获取 HTTP 状态代码 |
| `goto <url>` | 导航到一个 URL并返回页面/ 回复信息 |
| `exec <file>` | 在新页面上运行脚本文件并打印它返回的内容 |

### 执行示例

`exec` 取一个文件而不是 URL。 文件导出一个函数( CommonJS) `module.exports` 或ES模块 `export default`) (中文(简体) ). CLI打开一页并呼叫 函数 `{ page, browserless, opts }`数字 :

-   `page`:在新浏览器上下文中的新Puppeter页面.
-   `browserless`: 无浏览器上下文,用于 `browserless.goto(page, { url })` 还有其他的API.
-   `opts`: 命令行旗,加上 CLI 默认值 `codeScheme`。 。 。 . `--headless` 财务报告和审定财务报表 `--verbose` 被CLI消耗,没有通过. `--timeout` 并设置浏览器超时.

```js
// title.js
module.exports = async ({ page, browserless, opts }) => {
  await browserless.goto(page, { url: opts.url })
  return { title: await page.title() }
}
```

```sh
browserless exec title.js --url=https://example.com
```

文件路径从当前目录中解析 。 已打印返回的字符串 就像JSON那样 还有其他价值. `undefined` 和 二进制值 (buffers和打出数组,例如: `page.screenshot()`) 打印 没有, 所以从脚本中将二进制输出写入文件 。 检查文件 在浏览器启动前。 抛出的错误是 打印并使用代码 1 的流程退出 .

### 抓取实例

```sh
# mp4 (default)
browserless capture https://example.com --path=./capture.mp4

# webm output type
browserless capture https://example.com --type=webm --path=./capture.webm
```

> **说明:** 这个 `lighthouse` 命令需要额外安装.
> 
> 请通过运行确保安装独立的软件包 :  
> npm 安装 -g @ 无浏览器/ 灯塔

### 如何适合在单体

此软件包取决于 :

| 依赖性 | 目的 |
| --- | --- |
| @ 浏览/ 抓取 | 基于扩展的 CLI 视频记录标签抓取 |
| 无浏览器 | 所有浏览器自动化操作的核心 API |
| @ 无眉/ 灯塔 | 灯塔审计一体化(由灯塔指挥部使用) |

CLI充当了薄薄的包装器来解析命令行参数,初始化一个无浏览器实例,并向适当的命令处理器代表.

## 许可证

**@ 浏览器无/ cli** © [微链接](https://microlink.io/),在 [麻省理工学院](https://github.com/microlinkhq/browserless/blob/master/LICENSE.md) 执照.  
作者和维护者 [微链接](https://microlink.io/) 由来自 [捐助者](https://github.com/microlinkhq/browserless/contributors)。 。 。 .

这个 [标志](https://thenounproject.com/term/browser/288309/) 设计由 [辛赫工作室](https://xinh.studio/)。 。 。 .

> [微链接.io](https://microlink.io/) • GitHub 软件 [微链克](https://github.com/microlinkhq) • X [@microlinkhq (英语)](https://x.com/microlinkhq)

## 常见问题

### @browserless/cli 是什么？

无头浏览器自动化的命令行界面\. 取出截图,生成PDF,并取出网站的内容\.

### 如何安装 @browserless/cli？

在项目目录运行 npm install @browserless/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 browserless，可以用 npx browserless 直接运行。

### @browserless/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/browserless\_\_cli 是否存在。

### @browserless/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @browserless/cli 可以商用吗？

@browserless/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @browserless/cli 的下载量有多少？

根据 npm 官方下载统计，@browserless/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 4,394 次，日均约 146 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @browserless/cli 还在维护吗？

最新版本 14\.1\.8 发布于 2026/11/08（今天）；至今共发布 478 个版本，其中过去 12 个月发布了 129 个；首次发布于 2020/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。