核心用法
kai-report-creator 是一款面向报告生成的专业工具技能,处理从结构化计划到最终HTML渲染的完整工作流。用户可通过 /report 命令配合多种 flags 调用:
- `--plan "topic"`:先生成
.report.md中间表示(IR)文件,建立报告结构后再渲染,适合复杂报告 - `--generate [file]`:将 IR 文件或上下文中的 IR 内容渲染为自包含 HTML;无文件参数时自动提取上下文中的有效 IR 块
- `--review [file]`:基于检查清单对已有 HTML 报告进行自动优化
- `--themes`:生成主题预览文件
- `--from <file>`:智能识别输入类型(IR 或原始内容),自动选择处理路径
- `--theme/--template/--output`:分别用于覆盖主题、使用自定义模板、指定输出路径
- `--bundle`:将 CDN 资源内联,实现完全离线可用
- `--export-image [mode]`:生成 PNG 截图(支持即时通讯、移动端、桌面端三种模式)
默认输出文件名为 report-<YYYY-MM-DD>-<slug>.html,slug 经标准化处理(小写、ASCII、30字符限制)。
显著优点
1. 零依赖部署:生成的 HTML 文件自包含,无需外部服务器或运行时依赖,CDN 资源可选内联
2. 数据与表现分离:强制使用 IR(中间表示)作为桥梁,用户负责数据真实性,AI 负责结构设计,杜绝虚构数据
3. 严格的契约验证:从 IR 语法检查、HTML 质量门控到 L2 Shell 检查的多层验证体系,确保输出可靠性
4. 渐进式披露设计:保留 report-summary、章节标注和组件数据的机器可读性,兼顾人工阅读与自动化处理
5. 丰富的主题生态:内置 8 种主题(corporate-blue、minimal、dark-tech 等),支持自定义模板扩展
6. 中英双语同等支持:自动检测 CJK 内容并适配占位符、目录标签、日期显示等元素
7. 全链路质量保障:12 步生成流程包含预写入验证、HTML 质量门控、L2 Shell 检查、静默审阅四道关卡
潜在缺点与局限性
- 非 PPT/PNG 导出工具:明确不负责将成品 HTML 转换为演示文稿或图片序列,需配合
kai-html-export或kai-slide-creator使用 - 图表依赖 ECharts:所有图表必须基于 ECharts,不支持其他可视化库
- Playwright 可选依赖:图片导出功能需要 Playwright,未安装时仅打印指引而不阻断主流程
- 主题定制门槛:自定义主题需遵循 CSS 变量契约,需阅读
references/theme-css.md等参考文档 - IR 学习成本:复杂报告需理解中间表示(IR)的 YAML frontmatter、Markdown 正文、组件围栏三段式结构
适合人群
- 需要定期产出数据看板、商业报告、研究文档的分析师与产品经理
- 追求报告可移植性、需离线交付或嵌入内网的政企用户
- 希望建立标准化报告模板、实现人机协作工作流的团队
- 中英文双语工作环境下的国际化业务团队
常规风险
| 风险类别 | 说明 |
|---------|------|
| 数据真实性 | AI 绝不虚构数据,缺失值明确标注 `[数据待填写]`,需人工补全 |
| 版本兼容性 | 依赖 `data-version` 等元数据锚点,跨版本模板混用可能导致样式异常 |
| 导出功能依赖 | `--export-image` 需 Playwright 环境,生产环境部署前需验证 |
| 自定义模板维护 | 非官方主题/模板不受长期兼容性承诺保护 |
| 自动审阅边界 | `--review` 的 AI 建议规则仅在置信度高且事实准确性可保障时应用,关键内容仍需人工复核 |
架构特色
采用"薄路由 + 引用分离"设计:SKILL.md 仅保留命令路由与核心原则,详细规则分散在 15+ 个引用文件中,按需加载避免提示膨胀。同时通过 shell 模板、IR 契约、渲染规则三层抽象,实现主题、内容、交互的解耦。