01安装入门
交给 Agent 安装
复制下面的提示词给你的 Agent。它会先核对环境与冲突,再按仓库说明安装和验证。
请帮我设置 Obsidian Codex Workbench。开始前先检查 Node、pnpm 和当前工作目录,并确认不会读取、复制或提交我的个人 Vault 内容。阅读 duxinrui9-gif/obsidian-codex-workbench 仓库的 README、安装说明和 MIT 许可证后,按仓库提供的方法从只读模式启动。完成后执行仓库提供的校验方式,并告诉我环境要求、启动结果和第一次如何使用。遇到路径冲突、权限问题或来源无法确认时请停止并说明原因。
它解决什么问题
Workbench 让 Obsidian 里的知识入口、项目目录里的协作规则和 Codex 的执行过程放在同一条可追溯的工作流中。它尤其适合长期项目:资料不会只停在一次对话里,下一步也不需要从零解释。
开始前的两个原则
- 先从一个空的测试 Vault 和一个小型项目开始。
- 公开模板、个人知识库和客户资料必须保持分离。
初次设置建议使用只读方式接入资料。确认哪些目录可以读取、哪些目录绝不应被写入或提交,再逐步增加能力。不要一开始把整个 Vault 或全部项目放进工作台。
需要认识的四类能力
| 能力 | 用途 | 什么时候使用 |
|---|---|---|
| Ingest | 把明确选中的输入整理进知识库 | 收到已确认可保存的资料时 |
| Query | 从已有笔记中回答问题并标明证据 | 做研究、写方案或回顾决策时 |
| Health check | 检查 Vault 的链接、结构和风险信号 | 定期维护或大批量整理前 |
| Maturity audit | 评估知识卡是否有来源、边界和可复用性 | 想让知识库从收集走向可用时 |
它们的共同边界是:只处理明确选中的范围;不把私有内容复制进公开产物;不把自动整理当作对事实的最终确认。
第一次设置:从空白到可用
1. 检查环境和目录
确认 Node 与 pnpm 可用,按仓库说明安装依赖。选择一个空白测试目录作为首次运行位置,并确认现有项目不会被覆盖。遇到同名目录、权限异常或来源无法确认时,先停止。
2. 启动公开工作台
按仓库提供的启动命令运行工作台。终端会显示一个本地访问地址;在浏览器打开后,先确认页面和示例项目可以正常读取。不要把终端输出中的个人路径、账号信息或临时地址复制到公开文档。
3. 先以只读方式连接一个小范围
选择一个包含少量 Markdown 的测试项目。建立入口页,写下目标、当前任务、关键资料和最近一次更新。确认工作台能找到这些内容,但没有把它们复制到模板或公开目录。
建立最小项目上下文
一个刚开始的项目不需要很多文件,但建议先有以下四项:
README.md # 项目是什么、如何开始和如何验证
AGENTS.md # 协作边界、允许的操作和必须遵守的规则
architecture.md # 关键结构、数据和页面之间的关系
handoff.md # 当前状态、已验证项和下一步
让 Agent 在执行任务前先读取这些文档;没有这些文档时,先帮助建立最小版本,而不是直接大范围修改。每次阶段完成后更新 handoff,下一次协作就能从正确的位置继续。
把 Obsidian 组织成可回溯的系统
推荐从用途而不是软件来源出发:
00 Inbox暂存未判断的输入。01 Sources保存原始来源与必要背景。02 Notes提炼能复用的方法和判断。03 Topics汇聚长期维护的主题。04 Outputs保存课程、方案、页面等交付物。
每条重要内容记录来源、更新时间、证据状态和适用范围。需要公开时,只从确认过的正文抽取;截图、附件、内部示例、个人路径和访问入口都留在私有范围。
一个安全的日常节奏
早期可按下面的循环使用:先在 Inbox 收集;用 Query 找到已有知识;为当前项目建立任务卡;让 Agent 在明确边界内执行;最后在 handoff 记录结果。每一步都应该回答“哪些资料被使用、哪些没有被使用、怎样验证”。
资料进入 → 明确范围 → 形成计划 → 执行 → 审阅 → 写入 handoff
如果任务需要删除文件、发送内容、访问外部系统或公开发布,必须先由人明确授权。Workbench 的职责是让边界可见,不是绕过边界。
常见问题
可以直接把现有 Vault 放进去吗?
不建议。先复制一个小范围做只读验证,理解文件边界和同步行为后,再决定是否接入更多内容。
什么时候应该用 Skill?
当任务重复、输入输出稳定、操作范围清楚时。第一次调用选低风险任务,先确认它的说明和停止条件。
为什么需要 handoff?
它把“已经做了什么、验证了什么、还有什么待确认”留给下次协作。没有 handoff,长期项目很容易因为对话中断而丢失判断过程。
完成检查
当你能从一个项目入口找到资料和规则、用只读范围完成一次小任务、并在 handoff 中写下验证结果,Workbench 就已具备可持续扩展的基础。之后再逐步加入更多项目和可复用 Skills。