Skip to main content

本地优先的设计

Extension.js 运行在你自己的机器上:用 CLI 开发、运行并构建扩展。它有意止步于打包。 当打包好的构建产物准备好上架商店时,下一步是 extension.dev—— 赞助 Extension.js 的那个平台。

这条路径适合谁

前置条件

Extension.js 可以跑在 Node.js 22.12 或更新版本、Deno 2.5 或更新版本,以及 Bun 1.2 或更新版本上(Bun 从 Extension.js 4.1.21 起支持)。 CLI 会在任何其他代码运行之前检查运行时,低于各自下限的运行时会以退出码 1 结束, 并给出一条点名该运行时的升级提示。
开始之前,请先用 node --version(或 deno --versionbun --version)检查你的版本。

第一次成功的目标

1

搭建或运行一个扩展项目

使用 extension create,或选择一个模板作为起点。
2

启动 dev 并加载扩展

运行 extension dev,把构建产物加载到目标浏览器中。
3

验证更新行为

修改一处,确认扩展能够重新加载。
4

构建生产产物

至少为一个浏览器运行 extension build
首次运行。 extension dev 默认以 chromium 为目标,在一个版本固定的 Chrome for Testing 和隔离配置文件里运行你的扩展,从不触碰你日常上网用的浏览器。当本机还没有这个浏览器时, 首次运行会询问是否下载一次,下载完成后直接继续进入开发会话。回答 n 就不会下载任何东西。你可以随时运行 npx extension install chromium, 用 --browser=edge--browser=brave 使用已安装的浏览器,用 --chromium-binary <path> 固定任意二进制,或用 --no-browser 只启动开发服务器。非交互式 shell,包括 CI,不会被询问: 它会打印安装命令并停止。参见 为什么 Extension.js 会下载浏览器跳过托管下载

推荐阅读顺序

  1. 立即上手
  2. 创建你的第一个扩展
  3. 模板
  4. 命令总览

下一步