Addfox
  • 简体中文

      • CLI

      本页汇总 addfox CLI 支持的命令与参数。

      基本用法

      addfox <command> [options]

      在 package.json 中配置 scripts

      {
  "scripts": {
    "dev": "addfox dev",
    "dev:firefox": "addfox dev -b firefox",
    "build": "addfox build",
    "build:chrome": "addfox build -b chrome",
    "test": "addfox test"
  }
}

      命令

      命令说明
      dev启动开发模式（支持热更新）。
      build执行生产构建。
      test运行测试（参数会透传给 rstest）。

      addfox test 从 rstest.config.* 或 addfox.config 的 test 字段读取测试配置；两者同时存在时 rstest.config.* 优先。

      常用参数（默认值 + 配置映射）

      参数内置默认值对应 addfox.config 字段说明
      -b, --browser <browser>chromium无直接字段（影响目标与启动）指定目标/启动浏览器，详见下方支持的浏览器列表。
      --port <port>3000无直接字段Rsbuild dev server 端口，仅对 dev 生效。
      --keep-browser-profilefalsekeepBrowserProfile跨启动保留浏览器 profile(默认每次启动使用全新 profile)。
      --no-keep-browser-profilefalse（仅当前命令）keepBrowserProfile本次运行使用全新浏览器 profile。
      -r, --reportfalsereport启用 Rsdoctor 构建分析报告。
      --no-openfalse（即默认自动打开）无直接字段构建或开发时不自动打开浏览器。
      --debugfalsedebug启用调试模式（开发时错误监控等能力）。
      --help--显示帮助。
      --version--显示版本号。

      -c, --cache 与 --no-cache 是 --keep-browser-profile / --no-keep-browser-profile 的废弃别名，仍可使用，但终端会打印 deprecated 警告。

      支持的浏览器列表

      -b, --browser 参数支持以下浏览器：

      浏览器说明
      chromiumChromium（默认）
      chromeGoogle Chrome
      edgeMicrosoft Edge
      braveBrave Browser
      vivaldiVivaldi
      operaOpera
      santaSanta Browser
      arcArc Browser
      yandexYandex Browser
      browserosBrowserOS
      custom自定义浏览器（需在配置中指定 browser.custom）
      firefoxMozilla Firefox

      示例

      # Chromium 开发模式
addfox dev -b chromium

# 指定 dev server 端口
addfox dev --port 3100 -b edge

# Firefox 开发 + 调试
addfox dev -b firefox --debug

# 生产构建
addfox build -b chrome

# 构建但不自动打开浏览器
addfox build -b chrome --no-open

# 生成构建分析报告
addfox build -r

      入口路径与 HTML 模板

      传给 entry 的入口路径可以是脚本（.ts/.tsx/.js/.jsx）或 HTML 模板（.html）。

      • 脚本路径：框架以该脚本作为构建入口，并为需要 HTML 的入口自动生成页面。
      • HTML 路径：入口路径可以写成 popup/index.html，但你必须告诉框架真正的入口脚本。方法有两种：
        • 在 HTML 中给 <script type="module"> 标签加上 data-addfox-entry；
        • 在 HTML 旁边放置同名脚本文件（index.ts / index.tsx），让框架自动解析。

      详情与示例见 Config-based Entry。

      说明

      • --debug 主要作用于 dev 模式。
      • 默认每次启动使用全新 profile；需要保留登录态等状态时，用 --keep-browser-profile，或在配置文件中设 keepBrowserProfile: true（也可用 browser.<name>.keepBrowserProfile 按浏览器覆盖）。
      • -b/--browser 没有单独的 config 字段，属于命令级选择。