# 智能帮助系统资源目录

## 目录说明

此目录包含 DeepV Code CLI 智能帮助系统的知识库文件。

## 文件清单

### `cli-help-knowledge.md`
智能帮助系统的主知识库文件，包含：
- 所有斜杠命令的详细说明
- At 命令使用方法
- Shell 模式说明
- 配置系统文档
- 常见问题解答
- 使用场景示例
- 故障排查指南

**用途：** 作为 Help Subagent 的上下文，用于回答用户关于 CLI 功能的问题。

**维护：** 当 CLI 添加新功能或修改现有功能时，需同步更新此文件。

## 构建和打包

### 开发阶段
在开发时，文件位于：
```
packages/cli/src/assets/help/cli-help-knowledge.md
```

### 构建后
构建后，文件应被复制到：
```
dist/assets/help/cli-help-knowledge.md
bundle/cli/assets/help/cli-help-knowledge.md
```

### esbuild 配置
需要在 `esbuild.config.js` 中添加资源复制配置：
```javascript
{
  entryPoints: ['packages/cli/src/assets/help/cli-help-knowledge.md'],
  loader: { '.md': 'text' },
  outdir: 'dist/assets/help',
}
```

### 构建脚本
在 `scripts/build.js` 或 `scripts/copy_bundle_assets.js` 中添加：
```javascript
await copyAssets([
  {
    from: 'packages/cli/src/assets/help',
    to: 'bundle/cli/assets/help',
  },
]);
```

## 使用方式

### 在代码中加载
```typescript
import { readFileSync } from 'node:fs';
import { join, dirname } from 'node:path';
import { fileURLToPath } from 'node:url';

const __dirname = dirname(fileURLToPath(import.meta.url));
const helpKnowledgePath = join(__dirname, '../assets/help/cli-help-knowledge.md');
const knowledgeBase = readFileSync(helpKnowledgePath, 'utf-8');
```

### 用于 Subagent
```typescript
const systemPrompt = `你是 DeepV Code CLI 的智能帮助助手。

以下是完整的 CLI 功能知识库：

${knowledgeBase}

请根据知识库内容回答用户的问题。`;
```

## 知识库更新指南

### 何时更新
- 添加新的斜杠命令
- 修改现有命令行为
- 添加新的配置选项
- 修改默认值或行为
- 添加新的使用场景

### 更新流程
1. 修改 `cli-help-knowledge.md`
2. 验证内容准确性
3. 测试 Help Subagent 能否正确回答
4. 提交代码变更

### 内容原则
- **准确性：** 确保所有信息与实际实现一致
- **完整性：** 涵盖所有用户可能遇到的功能
- **清晰性：** 使用简洁明确的语言
- **示例：** 提供实际可用的示例代码
- **可搜索：** 使用关键词便于 AI 检索

## 相关文件

- **设计文档：** `docs/cli/智能帮助系统设计方案.md`
- **实现代码：** `packages/cli/src/ui/commands/HelpCommand.ts`（待实现）
- **Subagent：** `packages/cli/src/services/HelpSubagent.ts`（待实现）

## 许可证

遵循项目主许可证（Apache-2.0）。
