@fccf/theo

Theo

本地 AI 驱动的自动代码审查工具。每次 git commit 后自动触发代码审查，生成结构化报告，并提供 Web 仪表盘浏览历史记录。

功能特性

• 自动审查 — 提交后自动在后台执行代码审查，不阻塞工作流
• 三维审查维度 — 卫生检查（调试残留、死代码）、风险识别（逻辑缺陷、安全漏洞）、优化建议（性能、可读性）
• Web 仪表盘 — 按项目、分支浏览所有审查记录
• 系统托盘 — macOS 托盘图标，快捷打开 Web 界面
• Hook 兼容 — 支持 Husky、Lefthook 等已有 hook 管理器
• 桌面通知 — 审查完成后推送系统通知
• 可安装为 PWA — 支持添加到桌面，独立窗口运行

前置条件

• Node.js >= 18
• Claude CLI — 需要在 PATH 中可用（安装指南）

安装

npm install -g @fccf/theo

安装完成后自动完成初始化，并在浏览器中打开仪表盘。

快速开始

安装后，在任意 git 仓库中正常提交即可触发审查：

cd your-project
git commit -m "feat: add login page"
# Theo 自动在后台运行审查，完成后打开报告

CLI 命令

theo setup       # 安装钩子、启动服务和系统托盘
theo teardown    # 卸载并清理所有 Theo 文件和服务
theo inject      # 将 Theo 钩子注入当前项目（用于 Husky/Lefthook 项目）
theo remove      # 从当前项目中移除 Theo 钩子
theo doctor      # 检查安装状态是否健康
theo update      # 检查更新并重新执行 setup
theo version     # 显示当前版本

Husky / Lefthook 项目

如果项目使用了 Husky 或 Lefthook 等 hook 管理器，全局钩子可能被覆盖。在项目根目录执行：

theo inject

Web 仪表盘

安装后自动在 http://localhost:17930 启动。

页面	说明
首页	项目列表，显示各项目的审查数量和最近审查时间
项目页	按分支分组展示某个项目的所有审查记录
审查详情	显示完整审查内容：提交信息、分支、具体发现
设置	全局开关（自动打开审查、禁用项目列表）

卸载

npm uninstall -g @fccf/theo

卸载时自动清理所有文件和配置。

License

MIT