三分钟上手

快速开始

从零到第一个可交付结果，只有四步。整个过程的绝大多数时间花在第一步——想清楚你要什么。

1. 申请内测资格，通过后邮件收到安装包，安装并登录。
2. 导入一个仓库作为工作区，等待首次索引完成。
3. 用一个边界清晰的小任务试手，例如「给这个函数补测试」。
4. 确认产出符合预期后，再把规范文件补全，开始处理真实需求。

安装与要求

桌面客户端安装包 38 MB，支持主流 64 位操作系统；暂时内测，安装包按申请发放。服务端组件用于团队协作与私有化部署。

接入站点服务（公测）

站点的状态与表单接口已经上线，可以直接调用自检；客户端安装包在公测期按申请发放，避免版本错配。

# 查看服务状态（无需鉴权）
curl -s https://xg.xhoperf.xyz/api/v1/status

# 提交一条留言，返回工单号
curl -s -X POST https://xg.xhoperf.xyz/api/v1/contact \
  -H "Content-Type: application/json" \
  -d '{"name":"张三","email":"zhangsan@company.com","topic":"产品咨询与试用","message":"想了解重构场景的用法"}'

导入工作区

工作区是索引与规范的最小单位。可以包含多个仓库，也可以为不同产品线建立独立工作区。

# 将当前目录注册为工作区
lumina workspace add . --name billing-service

# 建立索引（大型仓库可加 --incremental 增量更新）
lumina index --workspace billing-service

# 查看索引状态
lumina workspace status billing-service

索引默认加密保存在本地用户目录。删除索引不会影响仓库，重新建立即可。

编写规范文件

规范文件名为 lumina.rules，放在工作区根目录，随仓库一起版本化管理。

# lumina.rules —— 团队约定示例
version: 1

structure:
  forbid: ["src/**/utils2/**"]        # 禁止新增第二套 utils
  require_tests: "src/**/*.ts"          # 源码必须伴生测试

security:
  forbid_secrets: true                     # 禁止明文密钥
  forbid_raw_sql: true                     # 禁止拼接 SQL

logging:
  format: json
  required_fields: [trace_id, user_id, level]

review:
  require_human_for: ["migrations/**", ".github/**"]

校验在提交前自动执行，未通过的改动无法提交，并给出命中的条款与修改建议。

快捷键

命令行

命令行工具适合放进流水线，行为与桌面端一致。

# 以非交互方式执行一个任务并输出补丁
lumina run "为新版导出接口补集成测试" --workspace billing-service --patch

# 仅做规范校验（适合放进 CI 的 pre-commit 阶段）
lumina lint --workspace billing-service --strict

# 导出任务档案，便于归档或复盘
lumina report --last --format json > report.json

接入接口

站点的状态与表单接口已经开放，可直接调用：写入类接口按来源 IP 限流（10 分钟 8 次）， 提交成功返回工单号，并同时触发一次通知邮件。团队版的任务编排 REST 接口部署在你的内网端点，鉴权方式见私有化部署文档。

# 服务状态
curl -s https://xg.xhoperf.xyz/api/v1/status

# 提交留言 → 返回工单号
curl -s -X POST https://xg.xhoperf.xyz/api/v1/contact \
  -H "Content-Type: application/json" \
  -d '{"name":"张三","email":"zhangsan@company.com","company":"某团队","topic":"技术支持","message":"重构场景怎么落地"}'

# 申请试用
curl -s -X POST https://xg.xhoperf.xyz/api/v1/trial \
  -H "Content-Type: application/json" \
  -d '{"email":"zhangsan@company.com","plan":"专业版","team":"8 人"}'

# 订阅版本更新
curl -s -X POST https://xg.xhoperf.xyz/api/v1/subscribe \
  -H "Content-Type: application/json" \
  -d '{"email":"zhangsan@company.com","source":"docs"}'

故障排查

索引一直停在某个百分比

通常是超大文件或二进制产物被纳入扫描。检查工作区内的忽略规则，确认已排除构建产物、数据集与压缩包。

规范校验误报

先确认规则范围是否过宽（例如把测试文件也纳入了 require_tests）。若规则本身需要长期例外，走例外审批而不是直接删规则。

私有化部署后客户端连不上

依次检查：服务端是否监听在内网地址、客户端配置的端点是否为 HTTPS、证书是否被系统信任。团队版可用内置的诊断命令一键收集日志：

lumina doctor --endpoint https://lumina.internal --verbose

---

找不到你要的内容？联系我们，或先看看 常见问题。