README file from
GithubXboard
Xboard 是一个本地优先的知识工作台，把常用捕获入口、知识库健康度、任务、日历和专注计时集中在一个可调整的仪表盘中。
- 插件 ID：
agent-dashboard - 版本：
2.3.1 - 作者：Yudan
- 最低 Obsidian 版本：
1.8.0 - 网络请求：仅在用户测试/刷新 RSS、主动开启 RSS 定时刷新或启动本地 AI 任务时发生
- 遥测和云同步：无
已实现
- 创建日记、项目日志和收件箱笔记，并在创建后打开。
- 将灵感追加到按日期保存的 Markdown 文件。
- 检查孤立笔记、0 字节空笔记、失效链接和无 YAML properties 的笔记。
- 显示知识库健康度、近一年笔记创建热力图和指定收件箱目录的文件数量。
- 将每日/每周任务持久化到用户指定的 Markdown 文件，支持优先级、DDL、完成、删除和排序。
- 在日历中查看任务日期和 DDL 紧迫程度。
- 使用专注/短休息计时器，并按日期保存已完成的专注轮数。
- 调整主题、字体、字号、布局密度、卡片顺序和卡片尺寸。
- 顶部欢迎语可以编辑，默认显示“你好！Xboarder！”。
- 上传封面、头像和相框图片，并在刷新或重启后继续显示。
- 使用 Vault 中的 Markdown 模板建立任意快速笔记，并自定义创建表单、保存目录和文件名。
- 配置多个 RSS / Atom 外部消息来源，按来源和分类查看最近内容。
- 手动或定时拉取外部资讯，并统一保存为
Xboard 数据/RSS 缓存/订阅缓存.json。 - 从“AI 临时对话”或“深度研究”对话框启动 Codex CLI 或其他命令行 AI。
- 保存多套 AI 工作流任务模板，并按任务切换工具、模型、思考强度、联网、读取范围、附件能力和运行时限。
- 为 AI 对话添加文档或图片，并在模型不支持多模态输入时给出提醒。
- 从通知文字中提取待办，经确认后建立一次性、每日或每周任务。
- 在 AI 对话和研究窗口内查看实时任务状态、已用时间、工具动作、连接重试和错误。
- 将每次 AI 结果先保存到
Xboard 数据/AI 运行/，再询问是否复制到正式知识库。
快速笔记模板
在 Xboard 设置的“快速笔记”中，可以添加、编辑、复制、排序或移除快速笔记类型。每种类型可以配置：
- Vault 中已有的 Markdown 模板文件。
- 新笔记保存目录和文件名规则。
- 是否固定到仪表盘顶部，以及创建后是否自动打开。
- 创建时要填写的单行文字、多行文字、日期、下拉选择或开关。
模板支持 {{title}}、{{content}}、{{date}}、{{time}}、{{timeCompact}}、{{datetime}}，以及用户为填写项设置的变量。无法识别的变量会原样保留。模板文件和保存目录都必须已经存在；Xboard 不会自动创建目录或覆盖同名笔记。
外部消息
在 Xboard 设置的“外部消息来源”中逐条添加 RSS / Atom 地址，可设置显示名称、分类和启用状态，也可以先测试连接。Xboard 不会因为打开仪表盘或普通刷新而联网，以下操作会访问订阅地址：
- 在设置中点击“测试连接”。
- 点击顶部“刷新外部消息”或“外部消息”卡片中的“刷新”。
- 主动打开“自动刷新外部消息”后，Obsidian 运行期间按选定间隔刷新。
拉取结果会先转换成统一 JSON，再写入可见的 Xboard 数据/RSS 缓存/。仪表盘只读取这份缓存；某个来源暂时失败时，会保留它上一次成功内容。默认保留最近 30 天、每个订阅最多 200 条，可在设置中调整。
Xboard 数据 是插件工作区，不参与知识库健康度、笔记热力图或知识库检查。AI 生成结果也会先进入这里，再询问用户是否保存到正式知识库。
AI 工具与对话
桌面版用户可以在设置的“AI 自动工作流”中保存多套“AI 工作流任务模板”，选择 Codex 或其他命令行 AI。默认的“自动查找”会识别 Codex、Claude、Gemini 和 OpenCode 的常见安装位置；只有自动查找失败时才需要手动填写程序位置。Xboard 不保存 AI 账号或 API 密钥；请先在对应工具中完成登录。
内置 AI 功能通过统一任务链路运行：任务编号进入任务注册表，工具解析器选择本地 AI，Agent Runner 负责启动、超时、停止和输出限制，最后由结果服务保存到 Xboard 数据区。后续任务可以复用这条链路，而不需要把复杂命令直接写进按钮事件。
“AI 临时对话”支持连续提问；普通对话和添加的文档、图片只存在于临时目录和当前窗口，不自动保存。Enter 发送，Shift + Enter 换行。点击“一键总结”后，才会把整次对话整理成 Markdown 并进入下方的结果确认流程；点击“结束对话”会直接清除临时内容。
AI 运行时，窗口内的任务轨道会显示准备材料、模型处理、等待确认和完成状态。Codex 的结构化事件会进一步显示搜索、工具调用、命令执行、输出生成、连接重试及错误；这里只展示可验证的运行动作，不展示模型私密的逐字推理。
默认使用“只允许独立数据区”：
- Codex 以
workspace-write模式运行，只把本次Xboard 数据/AI 运行/目录作为工作目录。 - 每次任务使用临时会话，不额外保留 Codex 会话日志。
- AI 返回的 Markdown 先保存为缓存结果。
- 任务完成后，Xboard 会再次询问是否复制到正式知识库。
“最高权限”会让 Codex 绕过审批和沙箱，可能访问或修改独立数据区以外的文件。只有在用户主动选择后才会启用。自定义命令行 AI 的权限由该程序自己决定，Xboard 无法替它强制沙箱。
自定义 AI 的启动参数每行填写一个，支持：
{{prompt}}：本次任务的完整要求。{{workdir}}：本次独立工作目录的系统路径。
为避免命令注入，Xboard 不通过 Shell 拼接命令，也不接受 .cmd、.bat 或 .ps1 作为程序路径。
即将实现
以下入口和卡片目前保留界面预览，并在界面中明确显示“即将实现！”：
- 每日简报。
这些尚未实现的功能不会发起外部网络请求，也不会要求填写 API 密钥。
手动安装
- 解压安装 ZIP，得到
agent-dashboard文件夹。 - 将文件夹复制到
你的知识库/.obsidian/plugins/。 - 确认插件目录包含
main.js、manifest.json、styles.css。 - 在 Obsidian → 设置 → 第三方插件中启用
Xboard。
首次使用
任务默认保存在 Vault 根目录的 Xboard 待办.md，首次添加任务时自动创建。
日记、项目日志、收件箱和灵感功能不会自动创建目录。使用这些功能前，请在 Xboard 设置中选择 Vault 中已经存在的目录。设置页会提示目录是否有效；未配置或不存在的目录不会再显示为“0 个文件”。
已有用户升级时，原来保存的非空目录和卡片配置会继续保留。
任务文件
Xboard 只管理任务文件中以下标记之间的内容：
<!-- xboard:tasks:start -->
<!-- xboard:tasks:end -->
标记之外的内容会保留。请勿删除、复制或打乱这两个标记；检测到损坏时，Xboard 会停止写入并显示错误，避免静默覆盖任务。
开发
npm install
npm run dev
npm run build
npm run lint
生产构建生成根目录的 main.js。最终安装目录只需要：
agent-dashboard/
main.js
manifest.json
styles.css
项目结构
src/
cards/ 卡片类型和注册信息
data/ 本地演示数据
modals/ 捕获、任务和知识库检查弹窗
rss/ RSS 类型、默认值和 XML 解析
services/ Vault、任务和统一动作服务
views/ 仪表盘视图
main.ts 插件入口
settings.ts 设置、默认值和配置迁移
已知限制
- 进行中的倒计时只在当前 Obsidian 会话中有效；上传的界面图片会保存到
Xboard 数据/界面图片/。 - 热力图使用文件创建时间；复制或同步工具可能改变该时间。
- 界面目前以中文为主。
- 为兼容 Obsidian 1.8.0，设置项暂不参与 Obsidian 1.13+ 的设置搜索。
- RSS 需要订阅源提供有效的 RSS、RDF 或 Atom 文档；需要登录或依赖网页脚本的站点不在当前范围。
- 本地 AI 任务仅支持桌面版；移动端仍可使用仪表盘、快速笔记、任务和 RSS 缓存。
- 当前接入“AI 临时对话”和“深度研究”入口；每日简报、今日复盘和更多自定义任务模板将在后续阶段接入。
后续计划
- 完善真实 Vault 和移动端测试。
- 继续缩小主 View 和样式文件，但不重写现有功能。
- 按“按钮 → 通用任务运行器 → 可选 AI → Xboard 数据结果 → 用户确认保存”的路径接入 AI。
- 保持界面与 Codex CLI、Claude Code、OpenCode 等具体 AI 产品解耦。
贡献
欢迎提交 Bug、文档改进和范围明确的小功能。开始前请阅读 CONTRIBUTING.md。
发布前的检查、双包交付和哈希核验步骤见 Xboard 发布审查规程。
隐私
Xboard 不包含遥测或云同步。只有用户明确测试/刷新 RSS、主动开启 RSS 定时刷新或运行 AI 任务时才会访问外部服务。RSS 返回内容与 AI 结果先保存到当前 Vault 的可见 Xboard 数据 目录。AI 访问哪些网络服务取决于用户选择的命令行工具；Xboard 不记录账号和密钥。