
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2910
使用教程
⚠ 本教程由 AI 依据该项目 README 整理;原始文档不完整,部分步骤为通用流程推断,实际安装请以项目官方文档为准。
⚠ 该项目 README 未提供完整安装说明,以下步骤为通用流程,请以官方文档为准。
环境要求
- git 仓库(也支持 Jujutsu/jj)
- 可运行 TUI 的终端环境
- 使用 AI 功能需准备 OpenAI 等提供商的 API Key
- 全局配置需可写入 ~/.config/lumen/ 目录
安装与启动步骤
-
1安装 lumen
README 的 Installation 章节未给出具体安装命令,请到仓库页面按对应平台说明安装;它是以单个静态 Rust 二进制形式发布的。
-
2交互式配置 AI
运行后在提示中依次选择 AI 提供商、填写 API Key 和模型名,设置会保存到全局配置文件。
lumen configure -
3查看代码差异
在仓库中查看 git diff;也可直接评审 GitHub PR,把编号换成目标 PR 的编号。
lumen diff --pr 123 -
4生成提交信息
先 git add 暂存改动,再执行该命令,lumen 会依据暂存内容生成符合规范的 commit message。
lumen draft -
5用配置文件固化设置
可选:在项目根目录创建 lumen.config.json,写入提供商、模型、密钥与主题等;优先级低于命令行参数。
{ "provider": "openai", "model": "gpt-5-mini", "api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "theme": "catppuccin-mocha", "wrap": true }
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
provider | 是 | 指定使用的 AI 提供商,如 openai | openai |
model | 是 | 指定调用的模型名称 | gpt-5-mini |
api_key | 是 | 提供商的 API 密钥,用于调用 AI 功能 | sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
theme | 否 | diff 查看器的配色主题 | catppuccin-mocha |
wrap | 否 | 是否自动换行长文本行 | true |
draft.commit_types | 否 | 自定义提交信息使用的提交类型及说明 | {"feat":"A new feature","fix":"A bug fix"} |
如何确认成功
在暂存了改动的仓库中执行 lumen draft,能输出 AI 生成的提交信息,即说明配置成功。
常见问题
Q:README 里没写安装命令怎么办?
A:请以仓库 Installation 章节和 Releases 页面为准;lumen 以单个静态二进制分发,按你所在平台选择对应方式安装即可。
Q:配置文件应该放在哪里?
A:三个位置任选:项目根目录的 lumen.config.json、用 --config 指定的自定义路径、全局目录(Linux/macOS 为 ~/.config/lumen/lumen.config.json)。
Q:多个项目要用不同提供商怎么配?
A:在各项目根目录分别放 lumen.config.json 写入不同 provider,或在运行时用 CLI 参数覆盖文件配置。
Q:不用 AI 功能可以吗?
A:可以。AI 提交信息与变更解释是可选能力,纯 diff 查看、分支与 PR 评审不需要 API Key。
注意事项
- 配置优先级从高到低为:CLI 参数 > --config 指定的文件 > 项目根目录 lumen.config.json > 全局配置文件。
- Windows 全局配置路径为 %USERPROFILE%\.config\lumen\lumen.config.json。
- lumen 同时支持 Git 和 Jujutsu(jj)仓库。
- README 节选中未提供安装命令与具体端口/路径参数,请勿自行臆造。
核心亮点
- 美观的 diff 渲染,支持语法高亮和分栏对比,提升代码审查效率
- 集成 AI 自动生成 commit message,减少手动撰写时间
- 纯 Rust 实现,性能好,安装简单,无运行时依赖
不足之处
- AI 功能需要额外配置 API 密钥,可能增加使用门槛
- 文档/社区待观察
适用场景
- 日常 git 提交时快速生成规范的 commit message
- 代码审查时清晰查看 diff 变更
- 在终端环境中快速了解代码改动摘要
替代项目
diff-so-fancy、delta、git-ai
同类项目推荐
rails-audit-thoughtbot
开源
让 Claude 按固定流程给 Rails 项目做代码体检
Claude skill to run code audits
JeecgBoot
开源
一句话生成整个系统,Java 开发效率翻倍
【AI 时代的业务系统基座】企业级 AI 低代码平台:权限、多租户、工作流、报表、大屏、AI ···
claudecode-best-practices
开源
照着做,让 Claude Code 干活更顺手
A collection of best practices and procedures for using Claude Code
codegen
开源
用聊天生成代码,快速验证你的编程想法
Salesforce codegen with web server
jupyter-studio
开源
让 Jupyter 拥有 Cursor 级 AI 能力,一键修复报错
The AI-native JupyterLab — open-source Cursor for notebooks. Cmd+K inline edit, mul···
copilot
开源
用 AI 自动补全代码,让编码速度翻倍
mancode
开源
给 AI 编码代理立规矩,少写废话代码
AI coding agent harness. Five modes: practice to playoffs. Stop your AI from over-en···
PiG
开源
把 TypeScript 版 Pi 编码智能体原样搬进 Go,行为不变、部署更轻
PiG (Pi in Go) is a faithful Go port of upstream Pi, the TypeScript codebase behind ···
echook
开源
给 AI 编程助手装上声音,任务完成/出错/限流秒知道
【Every star you give feeds a hungry developer's motivation!⭐️】 echook — AI-ope···