From 3d1cfd4f2264de201306c7e3d4f756bd504cb5b0 Mon Sep 17 00:00:00 2001 From: openclaw Date: Tue, 15 Sep 2026 08:14:37 +0800 Subject: [PATCH] docs: remove legacy accounting references --- README.md | 45 ++++++++++----------------------------------- 1 file changed, 10 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 9e9a08c..22c7ba4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # 🛠️ Ops-Assistant -多平台 Bot + 自动化运维一体的私人助理服务：**智能记账**、**Runbook 工单执行**、**模块化 OPS 命令**（Cloudflare / CPA / 订阅 / cfdav / 邮箱），带 Web 管理后台。 +多平台 Bot + 自动化运维一体的私人助理服务：**Runbook 工单执行**、**模块化 OPS 命令**（Cloudflare / CPA / 订阅 / cfdav / 邮箱），带 Web 管理后台。 -> 项目由 Xiaji-Go（记账机器人）演进更名而来；当前 `VERSION` 为 `0.0.1`（框架重构后重新起版，历史记账版本线为 v1.1.x）。 +> 当前 `VERSION` 为 `0.0.1`。项目定位为模块化 OPS 助手。 ## 🆕 框架版更新要点 -- **项目更名**：`xiaji-go` → `ops-assistant`（go.mod / 二进制 / systemd 同步） - **模块化命令框架**：`internal/core/module` 统一命令模板、门控（feature flag / confirm / dry-run）、错误标签（ecode）、结果格式化回传 - **Runbook 执行器增强**（`internal/core/runbook`）： - 新增动作：`http.get` / `http.post` / `assert.json`（支持 `expect_success` 严格断言，API 失败不再假阳性） @@ -21,11 +20,9 @@ ## ✨ 功能特性 - **多平台接入**：QQ 官方 Bot（WebSocket）、Telegram Bot、飞书（通道层预留） -- **智能记账**：自然语言识别金额与消费分类（jieba 分词，150+ 预设关键词） - **OPS 命令**：`/cf` `/cpa` `/cfdav` `/sub` `/mail`，写操作带 dry-run / 确认门控 - **Runbook 自动化**：YAML 定义、步骤编排、断言校验、任务审计 -- **Web 管理后台**：记录查看 / 删除 / CSV 导出、模块与渠道配置、任务与审计查看 -- **金额精确**：分（int64）存储，避免浮点误差 +- **Web 管理后台**：模块与渠道配置、任务与审计查看 - **优雅关闭**：SIGTERM/SIGINT 干净退出 ## 📦 快速开始 @@ -53,7 +50,7 @@ docker run -d --name ops-assistant -p 9621:9621 \ ### 从源码编译 ```bash -# 需要 Go 1.22+、GCC（gojieba 依赖 CGO） +# 需要 Go 1.22+ make build make build-linux ``` @@ -66,7 +63,7 @@ server: key: "your-secret-key" # 会话密钥 database: - path: "./xiaji.db" # SQLite 数据库路径 + path: "./ops.db" # SQLite 数据库路径 admin: username: "admin" # Web 后台用户名 @@ -84,28 +81,9 @@ qqbot: > **模块凭据**（CF API Token、CPA 管理令牌、cfdav 账号等）保存在数据库 `app_settings` 表，通过 Web 后台「模块设置」页配置，**不写入配置文件**；渠道 secrets 在数据库内加密存储（`enc:v1:` 前缀）。 -## 💬 记账功能 +## 🤖 Bot 与 OPS -### QQ Bot 关键词 - -| 关键词 | 说明 | -|--------|------| -| `帮助` / `菜单` | 显示帮助 | -| `查看` / `记录` / `列表` | 最近 10 条记录 | -| `今日` / `今天` | 今日消费汇总 | -| 直接发消息 | 自动记账（如"午饭 25元"） | - -### Telegram Bot 命令 - -`/start` `/help` `/list` `/today`，或直接发消息自动记账。 - -### 支持格式与分类 - -``` -午饭 25元 / 打车 ¥30 / 买咖啡15块 / 超市买水果38.5 -``` - -预设 150+ 关键词覆盖：🍜 餐饮、🚗 交通、🛒 购物、☕ 饮品、🍎 水果、🍪 零食、🏠 住房、📱 通讯、💊 医疗、🎮 娱乐、📚 教育、🚬 烟酒。 +Bot 主要用于接收 OPS 命令并返回执行结果。支持 QQ Bot、Telegram Bot；具体渠道开关与凭据在 Web 管理后台配置。 ## 🧰 OPS 命令参考 @@ -164,7 +142,6 @@ qqbot: 访问 `http://localhost:9621`： -- 📊 记账统计 / 最近记录 / 分类筛选 / CSV 导出 - 🧩 模块设置：CF / CPA / cfdav / AI - 🔌 渠道管理：QQ / Telegram / 飞书 配置与连接测试 - 🧾 OPS 任务与目标主机管理 @@ -190,12 +167,10 @@ ops-assistant/ │ │ ├── runbook/ # 执行器（ssh/shell/http/assert） │ │ ├── ops/ # OPS 服务编排 │ │ └── ai/ # AI 命令加载 -│ ├── module/ # 业务模块：cf / cpa / cfdav / mail / sub +│ ├── module/ # 业务模块：cf / cpa / cfdav / mail / sub / rate │ ├── bot/ # Telegram Bot │ ├── qq/ # QQ Bot（WebSocket）+ 订阅提醒调度 │ ├── feishu/ # 飞书适配（预留） -│ ├── service/ # 记账核心（jieba 分词） -│ ├── chart/ # 统计图表 │ └── web/ # Web 后台（Gin） ├── runbooks/ # 自动化 runbook（YAML） ├── templates/ # Web 前端页面 @@ -225,9 +200,9 @@ go build -tags runbooktest -o runbook_test ./cmd ## 📋 技术栈 -- **语言**: Go 1.22（CGO：gojieba） +- **语言**: Go 1.22 - **Web 框架**: Gin · **数据库**: SQLite (GORM) -- **分词**: gojieba · **QQ SDK**: tencent-connect/botgo v0.2.1（WebSocket）· **TG SDK**: go-telegram-bot-api v5 +**QQ SDK**: tencent-connect/botgo v0.2.1（WebSocket）· **TG SDK**: go-telegram-bot-api v5 - **自动化**: 自研 runbook 执行器（YAML 编排 + 严格断言 + 任务审计） ## 📄 License