# dsh-llmwiki

**Repository Path**: punkwen/dsh-llmwiki

## Basic Information

- **Project Name**: dsh-llmwiki
- **Description**: dsh-llm-wiki知识库，秒级个人知识库搭建
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2026-08-26
- **Last Updated**: 2026-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dsh-llmwiki

> Tigerkin LLM-Wiki 知识库的 DSH 插件——把一套完整的个人 AI 知识库框架集成到 DSH 中。

## 这是什么

`dsh-llmwiki` 是 [Tigerkin LLM-Wiki](https://gitee.com/punkwen/tigerkin-llm-wiki-build) 的 DSH 插件实现。它做三件事：

1. **设置页 UI** — 在 DSH 左下角「设置」中新增 LLM-Wiki 标签页（知识库路径管理 + 一键初始化）
2. **系统提示词注入** — 将 CLAUDE.md 行为契约嵌入 agent 的系统提示词，实现无感使用
3. **配置管理** — 知识库根目录路径的持久化存储与验证

## 架构

```
dsh-llmwiki/
├── lib/
│   ├── index.js          ← Host 半：配置存储 + HTTP JSON API + initializeWiki + 13 个 llmwiki-* slash 命令
│   └── client.js         ← Client 半：设置页（settings.section）——知识库路径管理 + 初始化按钮
├── knowledge-files/      ← 内置知识库骨架（初始化时复制到目标路径，免下载仓库）
│   ├── CLAUDE.md         ← 完整行为契约
│   ├── scripts/          ← init_wiki.py / lint.py / pdf_convert.py
│   ├── .claude/skills/   ← 13 个 skill 定义
│   ├── wiki/templates/   ← 5 个页面模板
│   └── wiki-system/      ← 5 个系统文件模板（__DATE__ 占位，初始化时替换成当天）
├── cordis.patch.yml      ← Profile 补丁：插入插件行
├── skills/
│   ├── wiki.md           ← 完整行为契约（CLAUDE.md 精简版）
│   └── wiki-ingest.md    ← 摄入操作技能
├── preset/
│   ├── agent.cordis.yml  ← Agent 预设组合（完整 standard 工具集 + LLM-Wiki 行为契约 persona）
│   └── preset.yml        ← 预设元数据
├── package.json
└── README.md
```

### 双面插件形态

| 字段 | 作用 |
|---|---|
| `exports["."]` | Host 半：Node 进程内的 cordis 插件（配置、HTTP JSON API、wiki_status 工具） |
| `exports["./client"]` | Client 半：浏览器 bundle（设置页 UI） |
| `dsh.bundle.patch` | Profile 补丁：向组合层 insert 插件行 |
| `dsh.client` | Client 半发现声明（platform: web） |

## 安装

> 这是**静态组合插件**（profile bundle layer + `dsh.client` 浏览器入口），不是动态 Cordis 插件。
> 装完后**重启 DSH 进程**生效；卸载用 `dsh plugin --profile web remove dsh-llmwiki`。

以下命令中所有 spec（`git+https://…`、包名、`link:.`）都由 DSH CLI 原样透传给 pnpm，
无需任何绝对路径；**在任意工作目录执行均可**。

### 1. 从 Gitee 安装（推荐，任意机器）

```powershell
npx @deepseek-ai/dsh plugin --profile web add git+https://gitee.com/punkwen/dsh-llmwiki.git
```

若本机已全局安装 dsh CLI，等价写法：

```powershell
dsh plugin --profile web add git+https://gitee.com/punkwen/dsh-llmwiki.git
```

装完**重启 DSH 进程**生效（profile 组合层变更不能热加载）。

### 2. 从 npm 安装（发布到 npm registry 后）

```powershell
npx @deepseek-ai/dsh plugin --profile web add dsh-llmwiki
```

### 3. 本地开发安装（仅开发者）

克隆本仓库到任意目录，然后在**仓库根目录**执行：

```powershell
git clone https://gitee.com/punkwen/dsh-llmwiki.git
cd dsh-llmwiki
dsh plugin --profile web add link:.
```

> `link:.` 是相对路径，CLI 会自动解析到当前目录，无需写绝对路径。

### 4. 安装预设（可选，推荐）

**无需手动复制**——插件安装后**重启 DSH 进程**时，host 半会自动把随插件发布的 `preset/`
同步到 `<DSH_HOME>\.agent-presets\llmwiki\`（`agent.cordis.yml` + `preset.yml`），
无需任何手工步骤。已存在的用户修改版预设会被保留（不覆盖）。

> 该自动同步在每次插件挂载（DSH 启动）时执行，幂等：仅当目标文件不存在时才写入。
> 若 `$env:DSH_HOME` 未设置，DSH 主目录默认为 `$env:USERPROFILE\.dsh`。

然后在 DSH 中新建会话，选择「LLM-Wiki」预设。预设把 CLAUDE.md 行为契约作为该会话
persona 注入，agent 自动遵循三层架构、11 步摄入流程、wikilink/Confidence 规则。

### 5. 前置要求

- **不需要**再单独下载 [Tigerkin LLM-Wiki 仓库](https://gitee.com/punkwen/tigerkin-llm-wiki-build)——插件内置完整知识库骨架
  （`knowledge-files/`：CLAUDE.md 行为契约、13 个技能、init_wiki.py/lint.py/pdf_convert.py 脚本、5 个页面模板、5 个系统文件），
  初始化时自动生成到目标路径
- Python 3.8+（用于 lint.py、pdf_convert.py）
- `pip install pyyaml`（lint 依赖）
- （可选）[MinerU](https://github.com/opendatalab/MinerU)——仅在摄入扫描型 PDF 时需要

## 使用

### 快速上手（三步）

安装并重启 DSH 后，按以下三步即可开始使用：

**① 设置知识库路径并初始化**

打开 DSH 左下角「设置」→「LLM-Wiki」标签页，设置一个**空目录**作为知识库根
（任意磁盘目录均可，如 `D:\MyWiki`），点击「🚀 初始化」——系统自动在该路径
生成完整知识库骨架（目录结构、系统文件、页面模板、CLAUDE.md 契约、脚本与技能）。
初始化是**幂等**的，可安全重复执行；完成后该路径即为知识库根（含 `CLAUDE.md` 与 `scripts/`）。

![step1-init](docs/step1-init.png)

> 如果你已有**下载的官方仓库**，直接设置其目录并点击「验证」即可，无需初始化（仓库自带完整骨架）。

**② 选择 LLM-Wiki 预设**

新建会话，在预设列表中选择 **LLM-Wiki**（插件安装后重启 DSH 会自动把预设放到
`<DSH_HOME>\.agent-presets\llmwiki\`，详见上文「安装预设」）。该预设把 CLAUDE.md
行为契约作为 persona 注入，agent 自动遵循三层架构、11 步摄入流程、wikilink/Confidence 规则
——无需手动向 agent 解释任何规则。

![step2 选择 LLM-Wiki 预设](docs/step2-setpreset.png)

**③ 在聊天框用 `/` 调出命令**

在会话聊天框中输入 `/`，命令菜单即弹出所有 `llmwiki-*` 命令，选择即可执行；
也可以直接输入完整命令，如 `/llmwiki-query 什么是价值投资`。

![step3 命令菜单](docs/step3-command.png)

### 知识库操作

**在聊天框输入 `/` 弹出命令菜单，或直接输入命令：**

所有命令带 `llmwiki-` 前缀（便于分组调用），执行时会把操作指令发给当前会话 agent，由 agent 按行为契约完成（无需手动向 agent 解释规则）。

**在聊天框输入 `/` 弹出命令菜单，或直接输入命令：**

所有命令带 `llmwiki-` 前缀（便于分组调用），执行时会把操作指令发给当前会话 agent，由 agent 按行为契约完成（无需手动向 agent 解释规则）。

| 命令 | 功能 | 示例 |
|------|------|------|
| `/llmwiki-ingest` | 摄入原始材料 | `/llmwiki-ingest`（扫描 raw/）或 `/llmwiki-ingest 某文章.md` |
| `/llmwiki-superingest` | 超级细致首次摄入 | `/llmwiki-superingest 某重要论文.pdf` |
| `/llmwiki-reingest` | 细粒度重新摄入 | `/llmwiki-reingest chopra-structural-dynamics` |
| `/llmwiki-query` | 简要查询 | `/llmwiki-query 风荷载如何计算` |
| `/llmwiki-q2` | 教科书式深度查询 | `/llmwiki-q2 钢梁抗弯承载力公式推导` |
| `/llmwiki-sq` | 极致详细查询（带算例） | `/llmwiki-sq 风荷载计算的完整推导与算例` |
| `/llmwiki-reflect` | 四阶段深度分析 | `/llmwiki-reflect` 或 `/llmwiki-reflect 价值投资` |
| `/llmwiki-lint` | 9 项健康检查 | `/llmwiki-lint` |
| `/llmwiki-merge` | 合并重复概念 | `/llmwiki-merge value-investing value-investing-cn` |
| `/llmwiki-addquestion` | 记录开放问题 | `/llmwiki-addquestion 价值投资的核心理念是什么` |
| `/llmwiki-outputhtml` | 导出 HTML 卡片 | `/llmwiki-outputhtml buckling-analysis` |
| `/llmwiki-htmlcard` | 生成 16:9 卡片 | `/llmwiki-htmlcard 价值投资` |
| `/llmwiki-outputob` | 导出 Obsidian 笔记 | `/llmwiki-outputob --all` |

> 注：命令在行为契约中的原生动词（`/ingest`、`/query` 等）会由插件转换后传给 agent，agent 按契约执行——你只需要用带前缀的命令名调出。

### 设置页

DSH 左下角「设置」→「LLM-Wiki」标签页**提供知识库路径管理**（设置、验证、修改、一键初始化），其余操作一律通过聊天框 `/` 菜单发出。

### CLAUDE.md 系统提示词

如果安装了预设（`preset/`），agent 会自动加载 CLAUDE.md 行为契约作为系统提示词。这意味着：
- agent 自动知道知识库的三层架构
- agent 自动遵循 11 步摄入流程
- agent 自动执行 wikilink 格式规范、Confidence 规则等
- **用户无需手动告知 agent 这些规则——无感使用**

## 典型工作流

```
原始材料 → /ingest → 概念/实体/来源页
                        ↓
                  /query（答疑）/ /q2（深度推导）/ /sq（带算例）
                        ↓
                  /reflect（发现模式与盲区）→ 补充新材料
                        ↓
                  /lint（健康检查）→ /merge（去重）
                        ↓
                  /outputhtml（导出分享）
```

## 技能一览

| 技能 | 作用 | 来源 |
|------|------|------|
| `/ingest` | 摄入原始材料，提取概念/实体 | tigerkin-wiki-ingest |
| `/superingest` | 极致细致首次摄入（L0-L8 九级颗粒度） | tigerkin-wiki-superingest |
| `/reingest` | 细粒度重新摄入已入库来源 | tigerkin-wiki-reingest |
| `/query` | 基于知识库回答问题（简要合成） | tigerkin-wiki-query |
| `/q2` | 教科书式深度查询（完整推导链） | tigerkin-wiki-query2 |
| `/sq` | 极致详细查询（带算例+量纲校验） | tigerkin-wiki-superquery |
| `/reflect` | 四阶段深度分析 | tigerkin-wiki-reflect |
| `/lint` | 9 项健康检查 | tigerkin-wiki-lint |
| `/merge` | 合并重复概念/实体（需确认） | tigerkin-wiki-merge |
| `/addquestion` | 记录开放问题 | tigerkin-wiki-addquestion |
| `/outputhtml` | 导出 HTML 知识卡片 | tigerkin-wiki-output-html |
| `/htmlcard` | 生成 16:9 知识卡片 | tigerkin-wiki-output-htmlcard |
| `/outputob` | 导出 Obsidian 笔记 | tigerkin-wiki-output-obsidian |

## 文件说明

| 文件 | 说明 |
|------|------|
| `lib/index.js` | Host 半：配置存储（~/.dsh/dsh-llmwiki.json）、/llmwiki/api/* HTTP JSON API、wiki_status 工具 |
| `lib/client.js` | Client 半：设置页（settings.section）——知识库路径+初始化按钮，通过 fetch 调 Host API |
| `cordis.patch.yml` | Profile 补丁：向 web profile 组合层 insert 插件行 |
| `skills/wiki.md` | 完整行为契约（CLAUDE.md 精简版，供 agent 加载） |
| `skills/wiki-ingest.md` | 摄入操作的详细技能说明 |
| `preset/agent.cordis.yml` | Agent 预设组合：完整 standard 工具集（bash/pwsh/fs/subagent/workflow 等）+ @deepseek-ai/dsh-persona 注入 LLM-Wiki 行为契约 |
| `preset/preset.yml` | 预设元数据（name + description） |

## 开发

```powershell
# 克隆到任意目录并进入仓库根
git clone https://gitee.com/punkwen/dsh-llmwiki.git
cd dsh-llmwiki

# 修改 lib/ 等代码后，重装插件（profile 组合层变更不能热加载，做完重启 DSH）
dsh plugin --profile web remove dsh-llmwiki
dsh plugin --profile web add link:.
# 重启 DSH web 进程生效
```

## 许可证

MIT License — 详见 [LICENSE](LICENSE) 文件。