关于 catalyst-smartbrowz
catalyst-smartbrowz 是用于使用 Catalyst SmartBrowz 浏览器自动化与文档生成组件的技能,面向开发者。它涵盖远程无头浏览器、服务器端浏览器逻辑、PDF 与截图、模板、浏览器网格及数据抓取。
主要功能
- 01连接 Catalyst 云端远程浏览器
- 02部署服务器端浏览器自动化函数
- 03生成 PDF 与截图
- 04设计动态内容模板
- 05配置并行浏览器网格
- 06使用数据抓取 API
适用场景
- 01通过 Puppeteer、Playwright 或 Selenium 执行浏览器自动化
- 02将网页或模板生成 PDF
- 03运行持久化的浏览器自动化任务
- 04并行处理浏览器请求
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ catalystbyzoho/ agent-skills --skill catalyst-smartbrowz安装后在 Claude Code 中输入/catalyst-smartbrowz确认已加载。
附带文件references/smartbrowz-basics.md
详细介绍
前置条件
使用 SmartBrowz 前,请先在控制台中为每个项目激活一次:
控制台 → 您的项目 → SmartBrowz(左侧边栏)→ 点击 "Start Exploring"
跳过此步骤将无法访问 Headless、Browser Logic、PDF & Screenshot、Templates、Browser Grid 和 Dataverse 组件。
**对于 Browser Logic 函数:**需要安装 Catalyst CLI。通过 CLI 初始化并部署 Browser Logic 函数(无法直接在控制台中创建,但可以上传)。
工作原理
-
多组件服务 — SmartBrowz 在一个统一平台中提供 6 个独立组件:
- Headless:通过自动化库连接到 Catalyst 云端的远程 Chrome/Firefox
- Browser Logic:包含浏览器自动化逻辑的无服务器函数(Java/Node.js)
- PDF & Screenshot:以编程方式生成可视化文档
- Templates:设计和存储动态内容模板
- Browser Grid(Early Access):可自动扩缩的并行无头浏览器
- Dataverse:数据抓取 API
-
选择工作流:
- Headless 模式:复制控制台提供的端点和代码片段,以连接 Puppeteer/Playwright/Selenium
- Browser Logic:通过 CLI 初始化,在 IDE 中编写代码,再部署到控制台 — 用于持久运行的浏览器自动化任务
- PDF & Screenshot:使用控制台 Playground、SDK(Java/Node.js/Python)或 API 生成文档
- Browser Grid:配置节点/浏览器数量,通过 CDP/Webdriver 端点连接,并行处理请求
-
加载
references/smartbrowz-basics.md— 查看组件详情、自动化库设置、Browser Logic 结构、PDF/Screenshot SDK 用法、Browser Grid 配置和故障排除 -
SDK 优先规则 — 编写实现代码时,始终优先使用 SDK 方法,而不是原始 REST API 调用:
- Node.js:
app.smartbrowz()(小写 —app.SmartBrowz()不是函数)→smartbrowz.convertToPdf()、smartbrowz.generateFromTemplate()、app.smartbrowz().browserGrid()→grid.getGrid()、grid.stopGrid() - Python:
app.smart_browz()→smart_browz.convert_to_pdf()、smart_browz.generate_from_template()、app.smart_browz().browser_grid()→grid.get_all_grid() - Java:
ZCSmartBrowz.getInstance()→smartBrowz.convertToPdf()、smartBrowz.generateFromTemplate() - 仅在没有对应的 SDK 方法时使用 REST API(例如,检查 Browser Grid 实时统计信息中的
free_sessions)
- Node.js:
-
关键概念:
- 远程浏览器在 Catalyst 云端运行 — 不在本地运行。端点由控制台自动生成。
- 连接代码中无需 api-key — Puppeteer/Playwright/Selenium 仅使用端点 URL 即可连接。
api-key仅用于 Browser Grid REST API 调用(例如,获取实时统计信息)。 - 目前仅支持 Chrome 浏览器 — Browser Grid 支持 Firefox(Early Access)
- Browser Logic 函数 = 无服务器函数类型 — 通过 CLI 创建,而不是通过控制台 UI 创建
- Browser Grid = 自动扩缩 — 根据配置按需启动节点和浏览器
- 控制台提供可用于测试自动化库用例的 Code Recipes
-
安全提示 — 任何浏览器自动化或网页抓取行为的风险均由您自行承担。仅在允许此类操作的域名上操作,或事先获得适当授权。
安全检查清单
- API 密钥保护:无头浏览器和浏览器网格的端点均使用自动生成的 API 密钥进行保护。如果密钥泄露,请重新生成密钥(注意:这会重置网格统计数据)。
- 浏览器逻辑日志:所有函数活动都会记录在 Console → DevOps → Logs 中。请查看日志以进行调试和安全审计。
- 浏览器网格队列限制:Selenium 请求的排队时间为 30 秒,Puppeteer/Playwright 请求为 5 分钟。超时后,请求会被终止。
- 浏览器网格警报:请在 Dashboard 中监控以下警报:浏览器创建被拒绝、磁盘使用量达到 90%、内存/CPU 使用量达到 80%、节点崩溃。
- 默认存储空间:浏览器网格节点的磁盘空间限制为 10GB。请监控磁盘使用情况,以防发生故障。
- 速率注意事项:浏览器自动化可能会产生大量网络流量。请留意目标网站的速率限制和服务条款。
触发条件
在以下场景使用此技能:"SmartBrowz"、"headless browser"、"Headless Browser"、"remote browser"、"Puppeteer"、"Playwright"、"Selenium"、"browser automation"、"Browser Logic"、"PDF generation"、"screenshot webpage"、"HTML to PDF"、"URL to PDF"、"template PDF"、"PDF/Screenshot generation"、"PDF & Screenshot"、"SmartBrowz templates"、"Browser Grid"、"parallel browsers"、"web scraping"、"Dataverse"、"CDP endpoint"、"Webdriver endpoint"、"headless Chrome"、"headless Firefox"、"browser testing" 或 "automation library"。
参考资料
| 参考资料 | 在查询涉及以下内容时加载…… |
|---|---|
references/smartbrowz-basics.md | 无头浏览器设置(Puppeteer/Playwright/Selenium 代码片段)、浏览器逻辑(CLI 命令、函数结构、部署)、PDF 和截图(控制台 Playground、Java/Node.js/Python 中的 SDK 用法、API 调用、HTML/URL/模板输入格式)、模板(设计、存储、动态内容)、浏览器网格(Basic/Light/Moderate/Heavy 配置、节点/浏览器设置、CDP/Webdriver 端点、工作流、警报、Active/Inactive/Idle 状态、仪表板、最佳实践)、Dataverse(数据抓取 API)、故障排查 |