liulijen/singlefile

SingleFile（命令行界面）

镜像概述

SingleFile是一款轻量的命令行工具，旨在将网页内容（含CSS、图片、脚本等资源）整合为单一HTML文件，无需浏览器扩展即可运行。它基于Node.js，支持多种浏览器后端（Puppeteer、Selenium WebDriver、jsdom），灵活满足不同场景下的网页存档需求。

核心功能

• 单文件保存：将网页所有资源嵌入HTML，生成独立可访问的文件
• 多后端支持：兼容Puppeteer（Chrome）、Selenium WebDriver（Firefox）、jsdom（无浏览器模拟）
• 批量处理：支持从文件读取URL列表进行批量保存
• 链接爬取：可配置爬取内部/外部链接，自定义深度和重写规则
• 灵活配置：支持指定浏览器路径、等待策略、输出格式等参数

使用场景

• 网页内容存档与备份
• 离线阅读资料准备
• 批量收集公开网页信息
• 自动化网页保存任务

配置说明

依赖安装

1. 安装Node.js环境（版本需兼容项目要求）
2. 安装Chrome/Firefox浏览器（或使用jsdom后端）
3. 全局安装：npm install -g "gildas-lormeau/SingleFile#master"
4. 手动安装：下载源码后执行npm install（进入cli目录）

运行语法

bash
single-file <url> [output] [options ...]

常用命令示例

• 显示帮助：single-file --help
• 保存网页到文件：single-file https://www.wikipedia.org wikipedia.html
• 使用Firefox后端：single-file https://www.wikipedia.org wikipedia.html --back-end=webdriver-gecko
• 批量处理URL列表：single-file --urls-file=list-urls.txt

故障排除

• 浏览器未找到：使用--browser-executable-path指定浏览器路径
• 保存超时：调整--browser-wait-until参数（如networkidle0）

Docker部署示例

拉取镜像

bash
docker pull liulijen/singlefile

运行镜像保存网页

bash
docker run liulijen/singlefile "https://www.wikipedia.org"

输出到本地文件

bash
docker run liulijen/singlefile "https://www.wikipedia.org" > wikipedia.html

许可证

SingleFile基于AGPL许可证，第三方代码基于MIT许可证。商业用途请联系作者获取授权。