文档生成
- 作者仓库星标 24,518
- 作者更新于 实时读取
- 作者仓库 DeepTutor
- 领域
- 文档
- 兼容 Agent
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- 信任分
- 88 / 100 · 社区维护
- 作者 / 版本 / 许可
- @HKUDS · 未声明 license
- Token 消耗评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部 API Key
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 底层运行要求
- 无特殊要求
- 文件与系统权限
-
- 只读
- 允许写入 / 修改
- Shell 执行
- 网络行为
- 仅限本地
- 安装命令数
- 26 条
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: knowledge-base
description: Manage DeepTutor knowledge bases — list, create, search, add documents, delete. Use the exec too…
category: 文档
runtime: 无特殊运行时
---
# knowledge-base 输出预览
## PART A: 任务判断
- 适用问题:PRD、RFC、README、项目说明或知识库整理。
- 输入要求:目标材料、限制条件、期望输出和验收方式。
- 证据边界:围绕“When to Use / Commands / List all knowledge bases”读取原文规则,不把推断写成作者承诺。
## PART B: 执行结果
- **01** 任务判断:确认你的需求是否属于PRD、RFC、README、项目说明或知识库整理,并标出输入、限制和预期结果。
- **02** 执行计划:优先按“When to Use / Commands / List all knowledge bases”拆成步骤,说明每一步会读取什么、修改什么、产出什么。
- **03** 交付结果:给出可复制的命令、文件改动、检查清单或内容草稿,并说明如何继续迭代。
- **04** 风险边界:结合 读取文件、写入/修改文件、执行终端命令、主要在本地完成、通常不需要额外 API Key 给出执行前确认项。
## Running Rules
- 读取文件、写入/修改文件、执行终端命令;主要在本地完成;通常不需要额外 API Key。
- 先小样例验证,再放大到真实任务。
- 交付时同时给结果、检查口径和下一步迭代建议。 先确认触发方式
原文出现了 `/path` 这类斜杠命令;如果你的 Agent 支持命令触发,优先用命令开场,再补充目标和边界。
给清楚输入和边界
告诉 Agent 目标文件或材料、期望结果、不可改范围、是否允许联网或执行命令。本 Skill 的权限画像是:读取文件、写入/修改文件、执行终端命令。
小样例验证后再放大
先用一个小任务确认它会围绕“When to Use / Commands / List all knowledge bases”工作;涉及文件或命令时,先看 diff、日志、预览或测试结果。
复核后再交付
检查最终产物是否包含明确结果、必要证据和下一步动作;如果输出泛泛而谈,就补充输入、边界和验收标准后重跑。
---
name: knowledge-base
description: Manage DeepTutor knowledge bases — list, create, search, add documents, delete. Use the exec too…
category: 文档
source: HKUDS/DeepTutor
---
# knowledge-base
## 什么时候使用
- 把项目文档方向的常用动作沉淀成 Agent 可调用的技能 适合处理README、PRD、RFC、教程和知识库文档,核心价值是把输入、判断、执行、验证和交付边界固定下来,避免 Agent 泛泛回答。 把任务拆成可执行、可检查、可继续迭代的…
- 面向PRD、RFC、README、项目说明或知识库整理,优先处理能明确输入、步骤和验收标准的工作。
## 需要提供什么
- 目标材料、目录范围、期望结果和不可改动内容。
- 是否允许联网、执行命令、读写文件或调用外部服务。
## 执行规则
- 围绕「When to Use / Commands / List all knowledge bases」组织步骤,不把推断写成作者事实。
- 读取文件、写入/修改文件、执行终端命令;主要在本地完成;通常不需要额外 API Key。
- 先跑小样例,确认结果可检查后再扩大任务范围。
## 输出要求
- 给出最终产物、关键证据、验证方式和下一步动作。
- 信息不足时标记 unknown,不编造命令、平台或依赖。 证据边界与执行链路
作者原文负责流程事实;仓库文件负责来源和命令;流狐只补充适用场景、限制和质量判断。
skill "knowledge-base" {
输入层 -> 用户目标 + 目标文件 + 禁止范围 + 验收标准
上下文层 -> When to Use / Commands / List all knowledge bases
规则层 -> SKILL.md 触发条件 / 执行顺序 / 输出格式
运行层 -> 无特殊运行时 | 读取文件、写入/修改文件、执行终端命令 | 主要在本地完成
安全层 -> 通常不需要额外 API Key + 小任务验证 + diff / 日志复核
输出层 -> 可复制结果 + 检查清单 + 下一步迭代
} Knowledge Base Management
Use the exec tool to manage DeepTutor knowledge bases via CLI.
When to Use
- User asks about their knowledge bases or study materials
- User wants to create, search, or manage a knowledge base
- User needs to add documents to an existing KB
Commands
List all knowledge bases
deeptutor kb list --format json
--format jsonoutputs machine-readable JSON instead of a Rich table.
Get info about a knowledge base
deeptutor kb info <kb_name>
Create a knowledge base
deeptutor kb create <kb_name> --doc /path/to/file.pdf
deeptutor kb create <kb_name> --docs-dir /path/to/directory/
Add documents to existing KB
deeptutor kb add <kb_name> --doc /path/to/new_file.pdf
Search a knowledge base
deeptutor kb search <kb_name> "<query>" --format json
Set a default knowledge base
deeptutor kb set-default <kb_name>
Delete a knowledge base
deeptutor kb delete <kb_name> --force
Tips
- Use
kb listfirst to see what's available before searching. - The
ragtool can also search KBs directly within the conversation — use it for quick lookups. - KB creation from large PDFs can take a few minutes.
- Always confirm with the user before deleting a knowledge base.
先判断是否适合
作者设计意图
作者的方法与取舍
边界和复核