dsh-showcase

dsh-showcase

把编程 Agent 的改动和测试结果，整理成可核验的中文交付报告。

dsh-showcase 是一个本地运行的 DSH 插件。它读取目标项目的 Git 改动、测试回执和可选截图，生成 Markdown 摘要与自包含 HTML 海报。

它不会上传项目文件，也不会把目标项目的数据写回本仓库。

本项目是社区工具，不是 DeepSeek、DSH 或《终末地》的官方产品。主题名仅描述视觉风格，不代表官方授权。演示素材说明见 CHARACTER_ASSET_NOTICE.md。

目录： 功能 · 快速开始 · 赞助商 · 产物 · 截图 · 工具参数 · 边界与安全 · 开发

先看效果

这是一个 DSH 插件 + 本地采集 CLI，不是只展示截图的主题包。插件负责把证据整理成摘要和海报；CLI 负责在任意目标项目中采集 Git 与测试回执。

你需要什么

• 必须：已经可以运行的 DSH Web 环境；
• 必须：Node.js 20+ 和 npm，用于安装本仓库及运行采集 CLI；
• 可选：Git。没有 Git 时仍会生成报告，但状态会明确标为 partial；
• 可选：Playwright 或其他浏览器验收工具。截图不是后端、CLI、库项目的必需项。

如果你只想查看海报，可以直接打开已经生成的 .showcase/layout-poster.html；如果你要让 DSH 读取新项目，按下面三步操作。

它能帮你做什么

支持前端、后端、CLI、Node.js、Python、Rust、Go、Java、库和静态 HTML 项目。

工作流只有一条：

目标项目 → init 配置 → capture 采集 → report.json → DSH 工具 → Markdown / HTML

5 分钟快速开始

dsh plugin --profile web add dsh-showcase

Set-Location C:\tools
git clone https://github.com/DoveLi-Gu/dsh-showcase.git
Set-Location .\dsh-showcase
npm ci
dsh plugin --profile web add "C:\tools\dsh-showcase"

Set-Location C:\work\your-project
$showcaseRepo = "C:\tools\dsh-showcase"

& "$showcaseRepo\node_modules\.bin\tsx.cmd" `
  "$showcaseRepo\src\cli\index.ts" init

{
  "task": "完成用户设置页并通过回归测试",
  "baseRef": "HEAD~1",
  "timeoutMs": 120000,
  "tests": [
    "npm test",
    "npm run build"
  ]
}

& "$showcaseRepo\node_modules\.bin\tsx.cmd" `
  "$showcaseRepo\src\cli\index.ts" capture

.showcase/
├─ config.json       # 任务目标、Git 基准、测试和超时
└─ report.json       # Git 改动、测试回执、截图记录和脱敏统计

{
  "projectPath": ".",
  "locale": "zh-CN",
  "generatePoster": true
}

.showcase/layout-summary.md
.showcase/layout-poster.html

$showcaseRepo = "C:\tools\dsh-showcase"
& "$showcaseRepo\node_modules\.bin\tsx.cmd" "$showcaseRepo\src\cli\index.ts" init
& "$showcaseRepo\node_modules\.bin\tsx.cmd" "$showcaseRepo\src\cli\index.ts" capture

赞助商

项目主赞助

鸽子中转站 · Pigeon API Relay

稳定、透明、易接入的 AI API 中转服务

鸽子中转站（Pigeon API Relay）兼容 OpenAI API 格式，重点提供 GPT-5.6 全系列、Claude Opus 5、Fable 5 等模型，同时覆盖多种国产模型，适用于 AI 编程、客户端接入、日常对话、内容创作和图像生成等场景。

平台支持余额按量与订阅套餐两种方式，包含灵活的日卡、月卡方案；模型价格和套餐权益清晰可查。你可以在一个控制台中统一管理 API Key、模型调用、余额、用量和订阅权益，并查看服务状态与详细接入文档。具体模型、价格及套餐权益以鸽子中转站站内实时信息为准。

兼容 OpenAI API · GPT-5.6 全系列 · 余额按量 · 日卡/月卡订阅

创建账户 · 模型与价格 · 订阅套餐 · 接入文档 · 服务状态

赞助商	介绍
鸽子中转站	稳定、透明、易接入的 AI API 中转服务，兼容 OpenAI API 格式。 重点提供 GPT-5.6 全系列、Claude Opus 5、Fable 5 等模型，同时覆盖多种国产模型，适用于 AI 编程、客户端接入、日常对话、内容创作和图像生成等场景。 平台支持余额按量与订阅套餐两种方式，包含灵活的日卡、月卡方案；用户可以统一管理 API Key、模型调用、余额、用量和订阅权益，并查看模型价格、套餐权益、服务状态和详细接入文档。具体模型、价格及套餐权益以站内实时信息为准。

最省事的用法

安装插件后，也可以让有终端权限的 DSH Agent 完成采集和汇总。把下面这段话里的工具目录改成你的实际路径：

使用 C:\tools\dsh-showcase 的 CLI 检查当前项目。如果没有 .showcase/config.json，先执行 init 并让我确认测试命令；然后执行 capture，最后调用 showcase_layout_summary 生成中文 Markdown 和 HTML 海报。不要上传任何项目文件。

这样用户只需要确认测试命令，不需要手动编写工具参数。

生成了哪些文件

本仓库已经默认忽略 .showcase/。其他项目也建议把它加入 .gitignore：

.showcase/

测试命令如何确定

init 会根据项目文件尝试填写默认测试：

测试也可以单独设置超时：

{
  "tests": [
    "npm test",
    {
      "command": "pytest -q",
      "timeoutMs": 180000
    }
  ]
}

没有识别到测试时仍会生成报告，但状态会是 partial。

截图证据

CLI 会保留 report.json 中已经存在的截图记录，但不会自动启动浏览器截图。

前端项目可以用 Playwright、浏览器验收工具或自己的截图脚本，把图片保存在目标项目内，再把记录加入 report.json.screenshots：

{
  "id": "desktop-after",
  "label": "桌面完成态",
  "theme": "frontier-signal",
  "viewport": {
    "name": "desktop",
    "width": 1440,
    "height": 900
  },
  "imagePath": "evidence/desktop-after.png",
  "capturedAt": "2026-08-20T10:00:00.000Z",
  "kind": "after",
  "url": "http://localhost:4173/"
}

截图规则：

• imagePath 必须位于目标项目内部；
• theme 使用 frontier-signal 或 blue-big-fish；
• 截图主题必须与 DSH 插件当前主题匹配；
• 缺失、过期、跨主题或不可读的截图不会被当成有效证据；
• 没有可视界面的项目可以不提供截图。

截图不是“随便放一张图片”：它必须属于目标项目、采集时间不能晚于报告、格式和尺寸必须可读，而且主题要和当前海报一致。跨主题截图会保留在报告里，但会从当前海报隔离出去。

frontier-signal 是“终末地帝江号”的内部兼容键，不是第三套主题；普通用户只需要在 DSH 设置中选择中文主题名。

工具参数

工具名：showcase_layout_summary

特殊项目结构示例：

{
  "projectPath": "C:/work/your-project",
  "appPath": "src/client/App.tsx",
  "cssPath": "src/client/styles.css",
  "locale": "zh-CN",
  "generatePoster": false
}

常见问题

为什么没有生成 HTML 海报？

检查插件设置中的海报开关，或在本次调用中传入 "generatePoster": true。Markdown 默认仍会生成。

为什么状态是 partial？

采集阶段通常是没有 Git 或没有可运行的测试命令；汇总阶段还可能额外提示截图缺失或过期。partial 的含义是“可以继续审查，但证据不完整”，不是程序崩溃。

为什么截图没有出现在海报里？

检查文件是否存在、路径是否位于目标项目内、capturedAt 是否早于图片修改时间，以及截图主题是否匹配。

可以用于非前端项目吗？

可以。后端、CLI 和库项目不要求截图，仍可生成 Git 与测试回执。

安全与边界

• 所有默认产物只写入目标项目的 .showcase/；
• 没有远程上传步骤；
• 常见 Token、Authorization、GitHub Token 格式和本机绝对路径会尝试脱敏；
• 报告最大 2 MiB，单张截图最大 8 MiB、尺寸不超过 16384 px；
• 每张海报最多嵌入 3 张有效截图；
• 脱敏不是绝对保证，公开分享前仍需人工检查。

从源码开发

npm ci
npm run check
npm run dev

主要目录：

src/                  CLI、报告 schema、Git、命令和脱敏逻辑
plugin/               DSH 插件、设置面板、摘要和海报生成器
tests/                单元、跨项目、极端输入和产物测试
docs/                 使用、上传、发布和预览素材
.github/workflows/    Node 20/22 CI

维护文档：

• 贡献指南
• 安全策略
• 发布检查清单
• GitHub 上传与维护指南
• 演示素材授权说明

许可证

源代码和普通仓库文件使用 MIT，详见 LICENSE。演示角色、照片和主题截图不自动包含在 MIT 授权中，详见 CHARACTER_ASSET_NOTICE.md。