会话演示生成器STFQ/dsh-showcase

dsh-session-showcase

CI
Node.js 22.19+
MIT License

dsh-showcase 将 DeepSeek Harness 会话转换为经过脱敏处理的动画 README 演示

English

从 DeepSeek Harness 会话生成可直接用于 GitHub 的演示。 dsh-session-showcase 可将官方 DeepSeek Harness（DSH）会话导出、原始 JSONL 日志或 Zstandard 会话日志转换为精美的动画 WebP/GIF、海报、社交预览图、README 片段以及机器可读的清单文件。它既可以作为独立 CLI 运行，也可以作为原生 DSH 工具插件运行。

它在本地运行，不执行任何会话工具，不上传任何内容，并且零 AI/模型调用。

对于 DSH，请将 GitHub 包安装到你使用的配置文件中：

dsh plugin --profile  add github:STFQ/dsh-showcase

该插件会注册 dsh_showcase。它通过 DSH 的文件系统提供程序读取本地会话导出，写入本地工作区，并且从不上传会话或调用模型。

为什么需要它

DSH 记录语义事件——提示词、工具调用、差异、结果和最终答案。屏幕录制器看到的是像素；dsh-session-showcase 看到的是这些事件，并将有用的时刻转化为简短、可重复的故事，用于 GitHub README、插件发布、issue 或 release。

|                 | 屏幕录制器 | 回放查看器        | dsh-session-showcase         |
| --------------- | --------------- | -------------------- | ---------------------------- |
| 输入           | 像素          | 完整记录      | 语义化 DSH 事件          |
| 输出           | 长视频      | 交互式调试器 | 简短、可直接用于 README 的动画 |
| 密钥处理 | 手动           | 因情况而异           | 默认开启脱敏      |
| 模型/API 使用 | 无           | 因情况而异           | 无                         |

快速开始

要求：Node.js 22.19 或更高版本。无需 FFmpeg，也无需 API 密钥。

立即试用（无需 DSH 账户或 API 密钥）

先渲染包含的安全测试夹具。这可以在大约 10 秒内验证完整的输出路径：

git clone https://github.com/STFQ/dsh-showcase.git
cd dsh-showcase
npm install
npm run build
node dist/cli.js examples/session.jsonl --output ./showcase --format both

渲染真实的 DSH 会话

1. 在 DSH Web UI 中，在你想分享的会话中运行 /export。DSH 会下载一个官方会话 ZIP。
2. 将插件安装到你使用的配置文件中：

dsh plugin --profile  add github:STFQ/dsh-showcase

该插件会注册 dsh_showcase 工具。让 DSH 渲染导出的 ZIP，例如：

在 dsh-session-.zip 上使用 dsh_showcase。将 WebP 和 GIF 都写入 ./.dsh/showcase，
使用默认的自动脱敏，并返回生成的产物路径。

3. 如果你只需要独立 CLI，请在下一个 npm 版本发布后安装该包：

npm install --global dsh-session-showcase

4. 在本地渲染它：

dsh-showcase dsh-session-.zip --output ./showcase

4. 将生成的片段复制到你的 README 中：

showcase/
├── hero.webp
├── poster.png
├── social-preview.png
├── README-snippet.md
└── showcase.manifest.json

同时生成动画 WebP 和 GIF：

dsh-showcase session.jsonl --format both --theme midnight

预览场景选择和脱敏，而不写入文件：

dsh-showcase session.jsonl --dry-run --json

它读取的内容

- 官方 DSH 会话导出 ZIP（归档根目录下的 session.jsonl）
- 原始 DSH session.jsonl
- 默认的拼接帧 session.jsonl.zstd
- 打包的 text-chunks、reasoning-chunks 和 tool-call-chunks 存储行
- 使用 - 的标准输入

0.2 版本新增了 DSH 插件入口点，同时保留独立 CLI。它会渲染根会话，并报告包含的子代理日志，但不渲染它们。参见已验证的兼容性契约。

隐私与脱敏

脱敏默认启用，涵盖常见 API 密钥、GitHub 令牌、JWT、bearer 令牌、密钥赋值、电子邮件地址、带凭据的 URL 以及主目录路径。

脱敏并继续（默认）
dsh-showcase session.jsonl --redact auto

检测到任何敏感内容时在写入前失败
dsh-showcase session.jsonl --redact strict

仅在审查源之后禁用
dsh-showcase session.jsonl --redact off

推理块和请求头永远不会被选为展示场景。脱敏是纵深防御，而非保证；发布前请审查生成的产物。阅读安全与隐私模型。

自动化与代理

--json 保持 stdout 仅输出机器可读内容；警告和错误输出到 stderr。版本化结果由 schemas/result.schema.json 描述。

dsh-showcase session.jsonl --dry-run --json > plan.json

代理入口点：

- llms.txt：紧凑的产品和文档地图
- docs/cli.md：完整的 CLI 和退出码契约
- docs/plugin.md：DSH 插件安装和工具契约
- docs/session-format.md：已验证的 DSH 适配器契约
- schemas/manifest.schema.json：生成的清单契约
- AGENTS.md：贡献者代理说明

常用选项

| 选项                             | 含义                           |
| ---------------------------------- | --------------------------------- |
| -o, --output                | 输出目录                  |
| --format webp\|gif\|both         | 动画输出格式                      |
| --theme deepsea\|midnight\|paper | 视觉主题                          |
| --redact auto\|strict\|off       | 敏感信息处理策略                  |
| --title                    | 封面标题覆盖                      |
| --max-scenes                | 场景数量（含封面）                |
| --dry-run                        | 仅解析和检查，不写入              |
| --overwrite                      | 替换已知的生成文件                |
| --json                           | 带版本号的机器可读标准输出        |

运行 dsh-showcase --help 或阅读完整的 CLI 参考。

设计参考

本项目遵循 DSH 会话/导出契约（固定于经验证的 rc.8 修订版）以及既定的 CLI 约定，而非自创一种不兼容的转录格式。所审查的确切上游来源和成熟项目记录在 docs/design.md 中。改编自 DeepSeek Harness 的代码在 THIRD_PARTY_NOTICES.md 中保留了其 MIT 声明。

贡献与安全

参见 CONTRIBUTING.md。请按照 SECURITY.md 中所述使用 GitHub 私密漏洞报告；如果该功能不可用，请在不包含漏洞利用细节或隐私数据的情况下提交 Issue，以请求私密渠道。

dsh-session-showcase 是一个独立的社区项目，与 DeepSeek 无关联，也未获得其认可。提及 DeepSeek 和 DeepSeek Harness 仅用于描述兼容性。

简体中文

把 DeepSeek Harness 会话变成可直接放进 GitHub README 的演示素材。 dsh-session-showcase 可以读取 DeepSeek Harness（DSH）官方导出的会话 ZIP、原始 JSONL 或 Zstandard 会话日志，生成精致的 WebP/GIF 动图、封面、社交预览图、README 片段和机器可读清单；它既可以作为独立 CLI，也可以作为 DSH 原生工具插件运行。

它完全在本地运行，不执行会话中的工具、不上传数据，且 不会调用任何 AI 模型，不消耗 Token。

在 DSH 中，请把 GitHub 包安装到你使用的 profile：

dsh plugin --profile  add github:STFQ/dsh-showcase

插件会注册 dsh_showcase 工具，通过 DSH 文件系统读取本地会话并写入本地工作区，不上传会话，也不调用模型。

为什么做这个项目

DSH 会记录提示词、工具调用、代码差异、执行结果和最终回答等语义事件。录屏工具看到的是像素，而 dsh-session-showcase 能理解这些事件，并把真正有价值的节点整理成一段简短、可重复生成的故事，适合放在 GitHub README、插件发布帖、Issue 或 Release 中。

|               | 录屏工具 | 会话回放器     | dsh-session-showcase |
| ------------- | -------- | -------------- | -------------------- |
| 输入          | 屏幕像素 | 完整会话       | DSH 语义事件         |
| 输出          | 较长视频 | 交互式调试页面 | README 可用的短动图  |
| 敏感信息处理  | 手动     | 各不相同       | 默认自动脱敏         |
| 模型/API 消耗 | 无       | 各不相同       | 无                   |

快速开始

需要 Node.js 22.19 或更高版本，不需要 FFmpeg，也不需要 API Key。

立即试用（无需 DSH 账号或 API Key）

先用仓库内置的安全示例生成完整产物，约 10 秒即可确认流程：

git clone https://github.com/STFQ/dsh-showcase.git
cd dsh-showcase
npm install
npm run build
node dist/cli.js examples/session.jsonl --output ./showcase --format both

生成真实 DSH 会话演示

1. 在 DSH Web 界面的目标会话中运行 /export，下载官方会话 ZIP。
2. 把插件安装到你使用的 profile：

dsh plugin --profile  add github:STFQ/dsh-showcase
插件会注册 dsh_showcase 工具。可以这样请求 DSH 生成演示：

使用 dsh_showcase 处理 dsh-session-.zip，把 WebP 和 GIF 都写入 ./.dsh/showcase，
使用默认的自动脱敏，并返回生成文件的路径。

3. 如果只需要独立 CLI，等待下一版 npm 包发布后安装：

npm install --global dsh-session-showcase

4. 在本地生成演示：

dsh-showcase dsh-session-.zip --output ./showcase

4. 把生成的 README 片段复制到你的项目：

showcase/
├── hero.webp
├── poster.png
├── social-preview.png
├── README-snippet.md
└── showcase.manifest.json

同时生成 WebP 和 GIF：

dsh-showcase session.jsonl --format both --theme midnight

只检查场景选择和脱敏结果，不写文件：

dsh-showcase session.jsonl --dry-run --json

支持的输入

- DSH 官方会话导出 ZIP（根目录包含 session.jsonl）
- 原始 DSH session.jsonl
- 默认的多帧 session.jsonl.zstd
- text-chunks、reasoning-chunks、tool-call-chunks 压缩存储行
- 使用 - 从标准输入读取

0.2 版本新增 DSH 插件入口，同时保留独立 CLI；它会渲染根会话，并报告 ZIP 中的子 Agent 日志数量，但暂不渲染子 Agent。具体范围见已验证的兼容性契约。

隐私与脱敏

脱敏默认开启，覆盖常见 API Key、GitHub Token、JWT、Bearer Token、密钥赋值、邮箱、带凭据 URL，以及用户主目录路径。

自动脱敏并继续（默认）
dsh-showcase session.jsonl --redact auto

一旦检测到敏感值，在写文件前停止
dsh-showcase session.jsonl --redact strict

仅在你已检查源文件时关闭
dsh-showcase session.jsonl --redact off

推理内容和请求头不会被选为演示场景。脱敏只是纵深防御，并非绝对保证；公开前仍应检查生成物。详见安全与隐私模型。

自动化与 Agent

使用 --json 时，stdout 只输出机器可读 JSON，警告和错误进入 stderr。稳定结果结构见 schemas/result.schema.json。

dsh-showcase session.jsonl --dry-run --json > plan.json

面向 Agent 的入口：

- llms.txt：精简的产品与文档导航
- docs/cli.md：完整 CLI 与退出码契约
- docs/plugin.md：DSH 插件安装方式与工具契约
- docs/session-format.md：已核验的 DSH 格式适配说明
- schemas/manifest.schema.json：生成清单的数据契约
- AGENTS.md：贡献代码时的 Agent 指令

常用参数

| 参数                               | 含义                       |
| ---------------------------------- | -------------------------- |
| -o, --output               | 输出目录                   |
| --format webp\|gif\|both         | 动图格式                   |
| --theme deepsea\|midnight\|paper | 视觉主题                   |
| --redact auto\|strict\|off       | 敏感信息处理策略           |
| --title                    | 自定义封面标题             |
| --max-scenes                | 包含封面在内的场景数       |
| --dry-run                        | 只解析检查，不写文件       |
| --overwrite                      | 覆盖已知的生成文件         |
| --json                           | 输出带版本号的机器可读结果 |

运行 dsh-showcase --help，或阅读完整命令行文档。

设计参考

本项目遵循已固定到 rc.8 并完成核验的 DSH 会话与导出契约，同时参考成熟 CLI 规范，没有另造不兼容的会话格式。核验过的上游来源和参考项目记录在 docs/design.md。从 DeepSeek Harness 适配的代码在 THIRD_PARTY_NOTICES.md 中保留了 MIT 声明。

贡献与安全

贡献方式见 CONTRIBUTING.md。安全问题请优先按 SECURITY.md 使用 GitHub 私密漏洞报告；如果该入口不可用，只能创建不含漏洞细节或隐私数据的 Issue，以便索取私下联系渠道。

dsh-session-showcase 是独立社区项目，与 DeepSeek 无隶属或官方背书关系；文中使用 DeepSeek 和 DeepSeek Harness 名称仅用于说明兼容性。

许可证

MIT