Back to home

nyantused-cpun

folio

Folio (兰亭): consulting document-generation engine with 5-stage pipeline (intake, memory, methodology, deliverable, proof). Native DSH plugin stack: 15 tools, session-protocol events, L0 guard, agent preset. Swappable methodology packs, zero-key start.

Stars
1
Language
Python
Created
Aug 15, 2026
Updated
Aug 15, 2026

Introduction

兰亭(Folio)· 咨询/汇报材料生成引擎

材料生成引擎 + 可组合方法论包,首发深度适配 DSH。 Folio = 对开本/作品集:把客户扔进来的材料,装订成能送达的汇报材料。

Folio 是给 AI 宿主(DeepSeek Harness / Trae / Kimi 等)外挂的长程任务执行引擎,特化于一件事:从客户材料到咨询/汇报交付物的全链路——接入材料 → 建立记忆 → 应用方法论 → 生成产出 → 守住质量。

引擎做机械的,AI 做判断的,云端模型做按需补位的。 凡是「错了要重来、客户可见、可复现」的环节全部由确定性代码执行,模型只在判断、理解、生成语言处出手。


快速开始(≤5 分钟)

# 1. 获取
git clone <repo-url> folio
cd folio

# 2. 一条命令安装内核(建 venv + 装依赖 + 生成配置 + 自检)
.\setup\install.ps1

# 3. DSH 插件层(可选但推荐):15 个原生工具 + 会话协议事件 + agent preset + L0 守卫
.\setup\install-folio-plugins.ps1 -Install

# 4. 看自检结果
#    输出示例:✅ Python 3.12  ✅ 依赖齐全  ⚠️ PPT 转换工具链未装(HTML/DOCX 不受影响)
#              当前能力等级 L0:零 key 可跑(DSH 下读图/搜索/审查走宿主原生)

装完后:重启 DSH → 开新会话 → 直接说「帮我做一份 XX 方案」。引擎的 skills 会被 DSH 自动识别。

零配置起步:不配任何 key 也能跑(L0);配 1 个 embedding key 解锁语义召回(L1);配读图/搜索 key 解锁独立 CLI 场景(L2)。每个能力槽位的取舍见 docs/能力配置引导

能力等级(装多少用多少)

等级配置得到什么
L0切片 + BM25 + 生成渲染 + 质量门禁;DSH 下读图/搜索/独立审查走宿主原生
L1+1 个 embedding key语义召回("那个做化工的客户"→ 找到对应档案)
L2+读图/搜索 key独立 CLI 场景全量(非 DSH 宿主)

PPT 转换工具链(v0.1 说明)

HTML / DOCX / 报价三种格式零外部依赖,装完即用。PPT 转换依赖 node 工具链(HTML→PPTX 转换器):install 脚本会检测 node,缺失时标黄提示但不阻断安装——其余功能不受影响。工具链本身随 v0.2 发布(vendor 或 npm 分发),v0.1 期间 PPT 由 html-build 同源生成 .pptd 工程,转换步骤见 install 输出提示。

产品结构:五段价值链

#模块做什么
1接入材料(Intake)把客户扔进来的材料变成可检索的资产(建档·解析·切片·索引)
2建立记忆(Chronicle)跨会话记住项目事实与决策(决策记录·世界书·语义召回)
3应用方法论(Craft)按可替换的方法论框架把材料拆成事实(skill 路由·大纲·主题守卫)
4生成产出(Press)从事实渲染成四格式交付物(HTML/PPTX/DOCX/报价,同源)
5守住质量(Proof)机械检查 + 独立审查双层防幻觉(门禁·verify·review·引用审计)

三大卖点

  1. 深度适配 DSH:skill 原生识别 + 守卫插件 + 15 个原生工具 + 会话协议事件插件 + agent preset,两条命令装齐;
  2. 方法论可换可组合:换领域不换引擎——咨询/市场营销/投资分析的方法论以 Folio Packs 形式即插即换(楷书=轻包 / 行书=标准包 / 草书=重包),欢迎社区发布;
  3. 极致特化的长程任务:20 页材料进,四格式带质量门自动出,会话结束自动存档审计。

目录结构

folio/
├── src/          # 内核(63 个 CLI 命令 + 渲染器 + 检索/记忆/质量链)
├── skills/       # 11 个方法论 skill(含 packs-authoring 创作指南)
├── guard/        # DSH 守卫插件(L0 机械拦截,0.1.0-rc.4 含 shell 直写检测 + 作用域隔离)
├── plugins/      # DSH 插件层:folio-tools(15 个原生工具)+ folio-events(会话协议,preset 挂载)
├── preset/       # 兰亭 agent preset 模板(install-folio-plugins.ps1 安装时落盘/替换占位符)
├── setup/        # 一键安装脚本(install.ps1 内核 + install-folio-plugins.ps1 插件层)
├── docs/         # 定位 / 能力引导 / usage 快速上手教程
└── tests/        # 测试套件(63 个文件;基线含客户材料已裁,见下)

测试

.venv\Scripts\python.exe -m pytest tests

说明:原始测试基线(golden specs)含真实客户材料,发布版已裁剪;渲染回归测试可自行用虚构材料重建基线(tests/baseline_kit.py 的思路,见仓库历史)。

快速上手

30 分钟跑通第一份方案:见 docs/usage.md(虚构客户全流程教程,零 key)。

文档

方法论包(Folio Packs)

想给 Folio 换一套方法论(市场营销/投资分析/战略咨询)?skills/packs-authoring 就是教你创作的 skill——问答式生成包骨架,不需要写代码。欢迎发布你的方法论包。

社区生态 / 友情链接(持续维护)

Folio 聚焦「长程材料生成」,不重复造社区已经做好的轮子。以下社区项目可作为互补、对照或迁移入口;具体兼容性请以各仓库 README 与 awesome-dsh-plugins 的 L0-L4 兼容报告为准。

  • Awesome 目录
  • 已在兰亭路线中
    • DSH-better-sidebar — 右侧预览 / 迷你 IDE 工作台
    • dsh-at-file — 输入框 @文件 快捷引用(见 awesome 目录)
    • dsh-vision-toolkit — 社区读图全家桶,可作 vision-bridge 对照
  • 互补增强(优先补全)
    • DSH-better-sidebar — 右侧预览区 / 迷你 IDE 工作台(P0)
      • dsh-github-connector — GitHub 集成(P0,见 awesome 目录)
      • context-vista — Token 可视化(P0,见 awesome 目录)
      • dsh-agent-teams — 团队可视化 / 多 Agent 面板(P0,见 awesome 目录)
      • dsh-undo / dsh-record-replay / dsh-obsidian-export / dsh-share(P1 按需)
  • 参考 / 对照
    • dsh-plugin-claude-bridge / dsh-claude-move(Claude 生态适配暂不考虑)
    • dsh-memory-evolve(长期记忆设计参考)
    • ModLens / dsh-qwen-mm(社区读图方案参考)

详细对比见 docs/社区插件排查与兰亭友情链接建议_2026-08-15.md

P0 社区插件(右侧预览 / GitHub / Token / 团队)脚本已提供,但 2026-08-15 起暂缓启用(装而未挂):peer 依赖在 profile node_modules 缺失或双副本会引发 dsh-scope Symbol 分裂,官方 plugin 通道稳定后再开启。当前不要直接跑 -Install,可先 -DryRun / -Verify 看计划:

pwsh .\setup\install-community-plugins.ps1 -DryRun
pwsh .\setup\install-community-plugins.ps1 -Verify

脚本会从 awesome-dsh-plugins 自动解析仓库、clone 到 ~/.dsh/community-plugins/、建 Junction 并写 patch,最后重启 dsh web 生效。

状态与路线

  • v1.0.0(当前):首个正式发布——五段价值链全链路 + DSH 深度适配 + LLM host 模式(0 key 起步)+ 安装脚本/自检。变更见 CHANGELOG.md
  • v1.1 优先补全(开源后第一波)
    1. 右侧预览区:接入 DSH-better-sidebar(或自研 folio-preview 兜底)
    2. GitHub 集成:dsh-github-connector 或自研 folio_github 工具
    3. Token 可视化:context-vista 或自研会话 Token 面板
    4. 团队可视化:dsh-agent-teams 或基于 DSH subagent 事件的自研面板
  • v1.1 其余规划domain-pack.yml 方法论包契约(机械校验)+ 市场营销冒烟包 + PPT 工具链正式分发
  • 平台:Windows 首发(macOS/Linux 安装脚本待补);PPT 转换工具链要求见安装脚本输出

许可证

MIT · 中文名「兰亭」取自《兰亭集序》——材料亦可成章。