# @alwaysmeticulous/debug-workspace 中文文档

规范地址：https://npmcn.com/package/%40alwaysmeticulous/debug-workspace/

版本：3\.6\.0
npm 元数据更新时间：2026-11-05T16:24:56.734Z
中文译文更新时间：2026-11-05T23:08:09.534Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40alwaysmeticulous/debug-workspace
原文对照：https://npmcn.com/package/%40alwaysmeticulous/debug-workspace/?lang=original
项目主页：https://github.com/alwaysmeticulous/meticulous-sdk
源码仓库：https://github.com/alwaysmeticulous/meticulous-sdk

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

- 包体积（解压后）：575 kB，149 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：6 个
- 首次发布：2026-03-12T15:50:23.641Z
- 最新版本发布：2026-11-05T16:24:56.382Z
- 近 30 天下载量：353818（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：120（近 12 个月 120 个）

## 中文简介

共享调试工作空间管道, 用于调查 Meticulous diffs并重放

## 安装

```sh
npm install @alwaysmeticulous/debug-workspace
```

也可以使用：`pnpm add @alwaysmeticulous/debug-workspace`、`yarn add @alwaysmeticulous/debug-workspace`、`bun add @alwaysmeticulous/debug-workspace`

## README

# @ alwaysmeticulous/debug-work 空间

提供调试工作空间管道的共享软件包 [恶毒](https://meticulous.ai/) CLI (中文(简体) )`meticulous debug`(e) 调查视差 并重放问题.

## 它会做什么

由于重放diff ID或重放 ID (s),此套件 :

1.  **决定上下文** -- 从中获取关于测试运行及其重放 diffs 的元数据 冷酷的API,生产 `DebugContext` 与所有相关的身份证.
    
2.  **下载调试数据** -- 下载重放数据(日志、时间表、参数、资产),会话 录音,重放diffs,并测试将元数据运行到本地的工作空间目录. 下载 与可配置货币平行运行.
    
3.  **生成工作空间** -- 脚手架结构化目录,其中:
    
    -   **模板** - 说吧 `CLAUDE.md` 复制到 `.claude/` 和克洛德密码一起使用.
    -   **衍生分析文件** - 制作大型可重放数据的预计算文物 和可管理性:
        -   被过滤的日志(噪声断层日志)
        -   Diff 摘要(压缩截图diff结果)
        -   事件指数(每起事件一行时间摘要)
        -   网络日志( 协议请求日志)
        -   VT 进取( 分散的虚拟时间值)
        -   日志索引(每入一行日志摘要)
        -   截图时间背景( 围绕每个截图的事件)
        -   Diffs出错(错误只重放一次)和覆盖diffs(头对底JS覆盖)
        -   会议摘要、资产
        -   格式化资产(印刷的JS/CSS)
        -   截图 DOM 快照( 每张截图) `<name>.html` 从 `<name>.metadata.json`,在每回放时一起写 `screenshots/` 目录)
        -   DOM diffs( HEAD 的每个屏幕截图统一 diffs vs BASE 相當印出 HTML,取出) 从神秘的后端写到 `dom-diffs/` 作为 `.diff` 文件,兄弟会 `.full.diff` 完整文件上下文的文件,以及每页文件 `.summary.txt`. diffs (英语) 与Meticulus产品中所示的相同。 仅生成于 `replay-diff` 路径。 )
        -   PR diff( 基数和头数之间的源代码变化)
    -   **内容 JSON** -- 有所有ID、路径、文件大小、截图的机器可读元数据 地图,并重放比较数据.

## 重叠模板

`generateDebugWorkspace` 接受可选选项 `additionalTemplatesDir` 参数。 此文件中的文件 覆盖目录优先于与此软件包捆绑的基底模板. 对于 子目录( 代理, 技能), 基础文件先被复制, 然后覆盖文件 在顶部复制——所以重叠可以添加新的文件或用名称替换特定文件.

用于 `met_debug` (在内部Meticulous repo)提供特定管理员 模板、技能和自定义 `CLAUDE.md` 而不伪造基本包.

## 使用量

此软件包由 `@alwaysmeticulous/cli` 通过 `meticulous debug` 命令.

```typescript
import { runDebugPipeline } from "@alwaysmeticulous/debug-workspace";

await runDebugPipeline({
  client,
  replayDiffId: "some-replay-diff-id",
  screenshot: "screenshot-after-event-00042.png",
  createWorktree: (ctx, workspaceDir) =>
    createProjectWorktree({ debugContext: ctx, workspaceDir }),
  onWorkspaceReady: (workspaceDir, projectRepoDir) =>
    presentWorkspace({ workspaceDir, projectRepoDir }),
});
```

或使用单个步骤进行更多的控制:

```typescript
import {
  resolveDebugContext,
  downloadDebugData,
  generateDebugWorkspace,
} from "@alwaysmeticulous/debug-workspace";

const debugContext = await resolveDebugContext({ client, replayDiffId });
await downloadDebugData({ client, debugContext, workspaceDir });
await generateDebugWorkspace({
  client,
  debugContext,
  workspaceDir,
  projectRepoDir,
});
```

## 主要出口

-   `runDebugPipeline` --运行全管(解析,下载,生成工作空间).
-   `resolveDebugContext` - 决定a `DebugContext` 从重放 diff ID 或重放 ID .
-   `downloadDebugData` ——将数据和文物再放入工作空间目录.
-   `generateDebugWorkspace` -- 脚手架从模板生成工作空间目录 所有衍生分析文件.
-   `DebugContext`, (中文(简体) ), `ReplayDiffInfo` -- 描述已解析调试上下文的类型 .
-   `DEBUG_DATA_DIRECTORY`, (中文(简体) ), `getDebugSessionsDir` - 路径常数.

## 金属SDK的一部分

此软件包是 [细细的sdk](https://github.com/alwaysmeticulous/meticulous-sdk) 单相机.

## 常见问题

### @alwaysmeticulous/debug-workspace 是什么？

共享调试工作空间管道, 用于调查 Meticulous diffs并重放

### 如何安装 @alwaysmeticulous/debug-workspace？

在项目目录运行 npm install @alwaysmeticulous/debug-workspace，或使用 pnpm add / yarn add / bun add。

### @alwaysmeticulous/debug-workspace 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alwaysmeticulous/debug-workspace 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @alwaysmeticulous/debug-workspace 需要什么版本的 Node\.js？

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

### @alwaysmeticulous/debug-workspace 可以商用吗？

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

### @alwaysmeticulous/debug-workspace 的下载量有多少？

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

### @alwaysmeticulous/debug-workspace 还在维护吗？

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