# lumina

**Repository Path**: pure_hz/lumina

## Basic Information

- **Project Name**: lumina
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-11
- **Last Updated**: 2026-05-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lumina

**Lumina** 是跑在员工电脑上的端侧引擎：采集多显示器工作区 → 做去重与节流 → 生成结构化日报/周报/月报 JSON → 可选通过桌面应用 **「Lumina 工作复盘」** 浏览与验收。

本仓库强调 **可复盘、可自动化验收、可分发**：你既可以只跑 CLI（无 UI），也可以构建桌面 `.app`/安装器，按文档一键跑通端到端闭环（M08）。

---

## 30 秒读懂：仓库里有哪些“程序”

- **`lumina`（CLI / 引擎）**：负责采集、生成报表、企业同步等；既可一次性运行，也可 `run-agent` 常驻。
- **`lumina-desktop`（桌面）**：Tauri + React 的可视化壳，产品展示名为 **「Lumina 工作复盘」**。
- **Windows 额外**：`lumina-windows-service`（服务壳）。

更细的“为什么终端 OK、界面却空”的解释，直接看 **[docs/Lumina-进程与职责总览.md](docs/Lumina-进程与职责总览.md)**。

---

## 你能在这仓库里验收什么（事实口径）

- **采集与落盘**：`capture-once` 会在 `output_dir` 写入 `.webp`（若节流判定为 drop，则不落盘）。
- **节流与闸门**：`phash-check` / `layer1-check` 是不依赖截屏与配置的内存断言，用于快速回归。
- **报表 JSON（严格）**：日报/周报/月报落盘为 **严格 JSON**，核心字段为 `sections`（不再落盘 `body_markdown/inputs_summary` 这类旧字段）。
- **端到端闭环（推荐验收）**：M08 一键脚本会串起：自检 → 截屏/定时日报 → 周/月报 → BFF 同步 → `desktop-read-check`（与桌面同源读盘）。

---

## 最短上手（5 分钟路径，CLI）

**前提**：已安装 Rust（cargo）。Gemini Key 只放环境变量，不要写进仓库。

在 `lumina/` 根目录（能看到 `Cargo.toml`）：

```bash
cp config/lumina.example.toml config/lumina.toml
export GEMINI_API_KEY="..."

cargo run -- --config config/lumina.toml capture-once
cargo run -- --config config/lumina.toml daily-brief
```

说明：
- `--config` 是 Lumina 的全局参数；推荐写在子命令前，减少与 `cargo` 参数混淆。
- `capture-once` / `phash-check` 等并不依赖 Gemini；只有生成简报/报表才需要 Key。

---

## 一键闭环验收（推荐，macOS / Windows）

- **macOS**：见 **[docs/M08-集成验证/01-端到端闭环验收-macOS-流程图全覆盖一键.md](docs/M08-集成验证/01-端到端闭环验收-macOS-流程图全覆盖一键.md)**
- **Windows**：见 **[docs/M08-集成验证/02-端到端闭环验收-Windows-流程图全覆盖一键.md](docs/M08-集成验证/02-端到端闭环验收-Windows-流程图全覆盖一键.md)**

你应该以这条验收为“主真源”：它覆盖了跨模块契约（CLI ↔ BFF ↔ 桌面读盘）是否仍成立。

---

## 桌面应用（Lumina 工作复盘）

- **产品名**：`desktop/src-tauri/tauri.conf.json` 的 `productName = "Lumina 工作复盘"`（macOS `.app` 目录名随之变化）。
- **唯一图标文件**：`desktop/public/icon.png`（同时用于浏览器标签 icon 与 Tauri bundle icon）。
  - 要求：**PNG RGBA**（含 Alpha）。若不是 RGBA，Tauri 打包会报 `icon ... is not RGBA`。

---

## 文档地图（建议阅读顺序）

- **总体与架构**
  - [docs/Lumina-总体技术方案.md](docs/Lumina-总体技术方案.md)
  - [docs/Lumina架构与开发规约.md](docs/Lumina-架构与开发规约.md)
  - [docs/Lumina-端到端与分域流程图.md](docs/Lumina-端到端与分域流程图.md)
  - [docs/Lumina-进程与职责总览.md](docs/Lumina-进程与职责总览.md)
- **按模块的“可交付文档”**
  - M01 安装与分发：`docs/M01-安装与分发/`
  - M02 权限与常驻：`docs/M02-权限与进程常驻/`
  - M03 采集与全景：`docs/M03-采集与全景/`
  - M04 过滤与 Token 经济：`docs/M04-过滤与Token经济/`
  - M05 简报与归档：`docs/M05-简报与归档/`
  - M06 桌面端：`docs/M06-桌面端/`
  - M08 集成验证：`docs/M08-集成验证/`

---

## 仓库结构（crate 职责）

| 路径 | 职责 |
|------|------|
| `crates/lumina-types` | 值对象、错误类型 |
| `crates/lumina-domain` | 领域规则（pHash 判定、端口 trait） |
| `crates/lumina-application` | 用例编排（采集流水线、报表生成） |
| `crates/lumina-infrastructure` | xcap、图像 WebP、Gemini HTTP、文件上传等基础设施 |
| `crates/lumina-bootstrap` | 读取 `lumina.toml`、组装运行时（含 JSON-mode 提示） |
| `crates/lumina-core` | CLI 二进制 `lumina` |
| `crates/lumina-windows-service` | Windows 服务入口 |
| `desktop/` | Tauri 2 + React + Vite + Tailwind 的桌面壳（Lumina 工作复盘） |

---

## 许可

以各 crate 及依赖库许可证为准；配置模板与文档可用于 Lumina 产品化扩展。