Skip to content

Repository files navigation

byteworker

把你日常的飞书文档、会议、群聊、Meego、多维表格视图和风神看板,消化成一个可对话查询的个人工作知识库

面向飞书重度用户(软件工程师、算法研发、PMO、运营等)—— 信息散落在文档和群里、事后再也找不回?byteworker 把它们结构化沉淀下来,需要时一句话问出来。

设计理念

1. 实体图,不是文件堆 知识库是一张实体图,7 类节点:

  • 实体(持续更新):person 人员 · project 项目 · area 主题领域 · org 组织
  • 记录(产生即定型):event 事件 · decision 决策 · reading 外部读物

节点之间用 links 互链。一个项目会在多个会议、文档里被反复讨论 —— 它们全部汇聚到同一个 project 节点上持续生长,而不是散落各处。查「关于张三我都知道什么」= 他的 person 节点 + 所有链回他的事件/决策/项目。不用会漂移的「标签分类」,实体本身就是组织方式。

2. 逻辑与数据严格分离 本仓库只含 agent 逻辑(SKILL.md + DESIGN.md + templates/ + bin/),不含任何业务数据。你的知识库内容存在另一个你指定的目录,绝不进本仓库、绝不上传 —— 因为它通常含机密工作内容。本仓库可公开,你的知识库私有,两者物理隔离。

3. 消化,不只是存档 摄取时 agent 会真正「消化」原始信息:抽取决策与结论、分析各参与方的立场与动机、持续更新项目的目标/进展/风险。立场分析严格基于发言证据,区分【观察】与【推断】,证据不足就说证据有限 —— 不做无依据的猜测。

4. 可溯源、可回滚 原始输入逐字保留,每个节点都带 sources 指回原文。凡答案使用知识库事实,正文会用 [S1] 绑定到论文式引用,列出具体原始文档 / 妙记录屏 / 群聊窗口、原文时间与 byteworker 收录时间,方便核对可信度和是否可能过期。知识库目录是它自己的本地 git 仓库,每步操作可回滚。

5. 看板是实时视图 工作看板每次查看都重新渲染(项目状态实时拉取、陈旧项实时扫描),永远不会过时。

6. 待办用自然语言 直接说“明天下午三点提醒我提交周报”“刚才那个做完了”。byteworker 把相对时间规范化后写入 本地 todo.md,每次被调用时检查到期 / 临期事项;内部编号只做关联,不要求用户输入。

7. 报告由宿主自动调度 日报 / 周报不要求用户每天记命令。首次安装会引导你用 Codex、Claude 或 TRAE 的原生本地 定时任务自动运行;每次自动日报和周报都先检查并 digest 已登记的定期来源,再生成带出处的 报告快照。独立补偿任务会按 Byteworker 的 last-success 状态检查离线或休眠造成的缺口; 需要修复历史报告时仍可用自然语言要求补跑。

8. 新 session 只有一次静默 preflight Agent 每个 session 只调用一次 bin/byteworker preflight:自动更新、知识库定位、Todo、自动报告 设置与 Python/Node/lark-cli/meegle runtime 一次检查完。健康时完全没有输出;只有确实需要处理 时才返回有限 notice。后续命令统一通过 bin/byteworker 启动,不依赖 Agent 猜 NVM 或 Python 路径。

用法

安装后,用子命令或直接自然语言:

子命令 作用
/byteworker digest <飞书URL/会议/群/Meego或Base视图/风神看板/外部文章/本地md> 摄取 —— 把资料消化入库
/byteworker search <问题> 查询 —— 问知识库,带原始出处、收录时间与置信度
/byteworker update <节点/新进展> 更新 —— 某条知识有新进展
/byteworker brief 会前简报 —— 读飞书日历,为每个会议拉相关上下文
/byteworker dashboard 工作看板 —— 长期关注 / 需关注 / 今日进展
自然语言:“明天下午三点提醒我 X” 待办提醒 —— 增加 / 完成 / 延期 / 取消 / 查看个人待办
自动日报 / 周报 宿主本地定时任务 —— 每次先跑定期摄取,再生成报告;安装时引导设置
/byteworker context <增删改> 全局上下文 —— 对话式维护你的工作上下文(个人工作倾向、需要告诉模型的零散信息等)
/byteworker help 帮助

也支持自然语言,如「把这个文档存进知识库」「我们关于 X 定过什么」「后天提醒我跟进评测」。

浏览知识库

知识库节点是 markdown,直接读原始 md 格式不友好。byteworker 自带一个纯前端、只读的 viewer:

# 在 byteworker skill 目录下运行:
bin/browse.sh        # 起本地 viewer + 打开浏览器,Ctrl-C 停止(需 python3)

它起一个本地静态文件服务器(python3 -m http.server,零自定义后端):在一个临时目录里把 skill 自带的 viewer 与你的知识库数据目录挂在一起(只读),用 viewer 页面渲染 —— 左侧按 7 类列出全部节点 + 搜索框,点开渲染 md,frontmatter 与正文里的 links / 节点 id 都可点,沿实体图跳转。viewer 代码随 skill 分发、始终在本仓库内,你的数据目录一个字节都不写入;viewer 纯只读,编辑知识库仍走 byteworker skill。

⚠️ browse.sh 需要在本地、有浏览器、能跑本地服务的环境运行。如果你通过云平台 / 沙箱里的托管 agent(如托管 Codex / OpenClaw)使用本 skill,沙箱通常起不了 web 服务、也没有浏览器 —— browse.sh 在那种环境用不了,这是预期的、不是故障;那种情况直接用对话查询(/byteworker search)即可。

前置依赖

依赖 说明
byteworker 自身 gitjqbashpython3 >= 3.9 Python 用于确定性维护 Todo / 索引 / 链接;macOS:brew install git jq python;Linux:apt install git jq python3
内部数据源 lark-cli + meegle + 对应 skills + 用户授权 文档 / Base 使用 lark-cli;Meego 使用独立的 meegle OAuth;风神由 byteworker 原生只读客户端访问,只需单独注入用户态或服务态凭据。安装助手会询问现在启用哪些来源,跳过后也会在首次使用时引导

装好后运行 bin/check-deps.sh 可一键自查环境(逐项报 ✓/✗),运行期使用同一套 resolver 自动 发现 NVM、~/.local/bin、venv 和常见系统路径。依赖就绪不等于授权就绪; 可用 bin/byteworker source auth-status --source-type meego--source-type feishu_base--source-type aeolus 做无副作用检查。

安装

方式一:让 AI 助手安装(推荐)

把下面这句发给你的 AI 编码助手(Codex / Claude Code / OpenClaw / 其它):

按 https://raw.githubusercontent.com/ranjiao/byteworker/master/INSTALL.md 的说明,在我的环境里安装 byteworker skill;若发现之前没装好的残留,一并修复。

它会取来 INSTALL.md 照做 —— 自动判定宿主 agent、把 skill 装到对的位置、修复历史残留、检查依赖。

方式二:手动安装

# 按你实际用的 agent 改 SKILLS_DIR ——
#   Claude Code: ~/.claude/skills    Codex: ${CODEX_HOME:-$HOME/.codex}/skills    OpenClaw: ~/.openclaw/skills
SKILLS_DIR=~/.claude/skills
git clone https://github.com/ranjiao/byteworker.git "$SKILLS_DIR/byteworker"
"$SKILLS_DIR/byteworker/bin/check-deps.sh"      # 自查依赖,按提示补齐
# 可选:无副作用检查来源授权;ready=false 时按 INSTALL.md 第 5 步选择是否授权
"$SKILLS_DIR/byteworker/bin/byteworker" source auth-status --source-type feishu_base
# 风神(凭据配置见 INSTALL.md)
"$SKILLS_DIR/byteworker/bin/byteworker" source auth-status --source-type aeolus

把 skill 直接 clone 进 agent 的 skills 目录(而非 clone 到别处再 symlink)—— 这样最稳,且自动更新依赖的 git remote 一步到位。沙箱 / 云环境、多 agent 共用、残留修复等细节见 INSTALL.md

AI 助手安装完成后会直接带你走 上手引导:指定一个持久、私密的知识库数据目录(默认名 byteworker_kb),填写个人信息、职责和关注重点,并询问是否创建自动日报 / 周报。本地 定时任务创建后会立即 Run now 验证;摄取和查询演示可跳过。之后每周静默自动从 GitHub 更新。

知识库数据目录

你的实际知识库数据存在上面指定的独立目录(不在本仓库):

  • sources/ —— 每个结构化来源自己的 selector/filter/routine profile · knowledge/ —— 7 类节点笔记 · raw_data/ —— 摄取的逐字原文 · provenance/ —— 原始章节/评论/消息定位 · journal/ —— 操作日志
  • reports/ —— 日报 / 周报归档快照
  • INDEX.md —— 主索引 · dashboard.md —— 工作看板 · context.md —— 格式化用户上下文 · todo.md —— 本地个人待办

该目录含机密内容,仅本地、绝不外传;若在沙箱 / 云环境运行,务必选一个跨会话持久的路径,别放会被回收的临时盘。结构与字段设计见 DESIGN.md。 风神按 dashboard sheet 注册:每个 sheet 在 sources/ 中有独立参数,skill 仓库不保存任何 用户 dashboard、report 或 filter 配置。

文档

  • ARCHITECTURE.md —— 信息处理流程、代码分层、模块边界与演进约束
  • bin/README.md —— 确定性命令的用途、参数、示例与写入边界
  • INSTALL.md —— 安装与残留修复说明(可直接交给 AI 助手执行)
  • TUTORIAL.md —— 首次使用的上手引导剧本
  • SKILL.md —— skill 行为定义
  • DESIGN.md —— 存储结构与字段设计
  • TODOS.md —— 延后的功能

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages