|
@@ -4,21 +4,30 @@
|
|
|
|
|
|
|
|
一个技能覆盖:巡检、故障自诊断、补跑/重试、OSS 同步、列表排查、报告解读、**月报/年报按需聚合分析**、线上部署核验。
|
|
一个技能覆盖:巡检、故障自诊断、补跑/重试、OSS 同步、列表排查、报告解读、**月报/年报按需聚合分析**、线上部署核验。
|
|
|
|
|
|
|
|
-## 快速开始
|
|
|
|
|
|
|
+## 快速开始(在线安装)
|
|
|
|
|
|
|
|
```bash
|
|
```bash
|
|
|
-# 1. 安装(Windows): 把本目录链接到 Claude 全局技能目录
|
|
|
|
|
-cmd /c mklink /D "C:\Users\11729\.claude\skills\smartbadge-ops" "D:\1\skills-smartbadge-ops"
|
|
|
|
|
|
|
+# 1. 克隆技能仓库到本地
|
|
|
|
|
+git clone https://git.fmode.cn/lami/skills-smartbadge-ops.git
|
|
|
|
|
+cd skills-smartbadge-ops
|
|
|
|
|
|
|
|
-# 2. 登录(在任意位置,技能会自行定位)
|
|
|
|
|
-node <技能目录>/scripts/api.mjs login <密码>
|
|
|
|
|
|
|
+# 2. 配置凭据(仅登录密码必需;OSS 四项见下方密钥清单)
|
|
|
|
|
+cp .env.example .env # Windows: copy .env.example .env
|
|
|
|
|
+# 编辑 .env,填写 SMARTBADGE_PASSWORD
|
|
|
|
|
|
|
|
-# 3. 一键核查
|
|
|
|
|
-node <技能目录>/scripts/check-online.mjs
|
|
|
|
|
|
|
+# 3. 登录并一键核查
|
|
|
|
|
+node scripts/api.mjs login <密码>
|
|
|
|
|
+node scripts/check-online.mjs
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
之后 Claude 中直接提问即可(如「昨天管道有问题吗」「帮我出 8 月月报」),技能通过「确认门」交互流程逐步完成。
|
|
之后 Claude 中直接提问即可(如「昨天管道有问题吗」「帮我出 8 月月报」),技能通过「确认门」交互流程逐步完成。
|
|
|
|
|
|
|
|
|
|
+### 安装为 Claude/通用 AI 技能(任选其一)
|
|
|
|
|
+
|
|
|
|
|
+- **Claude Code(Windows)**: `cmd /c mklink /D "%USERPROFILE%\.claude\skills\smartbadge-ops" "<本仓库绝对路径>"`
|
|
|
|
|
+- **Claude Code(macOS/Linux)**: `ln -s "<本仓库绝对路径>" ~/.claude/skills/smartbadge-ops`
|
|
|
|
|
+- **其他 AI**: 把仓库目录当作技能目录配置(含 `SKILL.md` 的目录即可)。
|
|
|
|
|
+
|
|
|
## 环境要求
|
|
## 环境要求
|
|
|
|
|
|
|
|
| 项 | 要求 |
|
|
| 项 | 要求 |
|
|
@@ -44,29 +53,26 @@ node <技能目录>/scripts/check-online.mjs
|
|
|
|
|
|
|
|
## 凭据与安全
|
|
## 凭据与安全
|
|
|
|
|
|
|
|
-- 本仓库**不含任何密钥**。登录 token 缓存 `.token`;OSS 凭据从项目 `server/.env` 自动发现。
|
|
|
|
|
-- 凭据定位回退链:`--env` 参数 > 环境变量 `SMARTBADGE_ENV_FILE` > 自动发现(本仓库同级/兄弟目录中名称含 `device|smartbadge` 且带 `server/.env` 的项目)> 已导出的 `OSS_*` 环境变量。
|
|
|
|
|
|
|
+- 本仓库**不含任何密钥**。登录 token 缓存 `.token`;OSS 凭据从服务端项目 `server/.env` 自动发现,或技能仓库根 `.env`,或进程环境变量。
|
|
|
|
|
+- 凭据定位回退链:`--env` 参数 > 环境变量 `SMARTBADGE_ENV_FILE` > 技能仓库根 `.env`(cp `.env.example` 填值)> 自动发现(本仓库同级/兄弟目录中名称含 `device|smartbadge` 且带 `server/.env` 的项目)> 已导出的 `OSS_*` 环境变量。
|
|
|
- 排查凭据定位:`node scripts/oss.mjs --find-env`。
|
|
- 排查凭据定位:`node scripts/oss.mjs --find-env`。
|
|
|
|
|
+- OSS 客户端两态:同机有服务端项目(`server/services/oss-client.js`)时复用其模块;否则自动回退内置零依赖实现(`scripts/oss-client-mini.mjs`,与 ali-oss 签名行为一致)。
|
|
|
|
|
|
|
|
## 给 AI 的完整配置提示(安装时粘贴)
|
|
## 给 AI 的完整配置提示(安装时粘贴)
|
|
|
|
|
|
|
|
-**步骤 1**:确认技能已就位——本仓库即技能本体(名称 `smartbadge-ops`),已链接到 Claude 全局技能目录:
|
|
|
|
|
-
|
|
|
|
|
-```bash
|
|
|
|
|
-cmd /c mklink /D "%USERPROFILE%\.claude\skills\smartbadge-ops" "本仓库路径"
|
|
|
|
|
-```
|
|
|
|
|
|
|
+**步骤 1**:克隆技能仓库(名称 `smartbadge-ops`)并按上方方式链接到 AI 技能目录。
|
|
|
|
|
|
|
|
-**步骤 2**:密钥清单。Windows 本机使用时**只需登录密码**(脚本会自动发现同机项目的 `server/.env` 读取 OSS 凭据);跨机/无项目目录环境才需要手工导出 OSS 四项:
|
|
|
|
|
|
|
+**步骤 2**:密钥清单。**只需 `SMARTBADGE_PASSWORD` 登录密码**(脚本自动发现同机服务端项目的 `server/.env` 读取 OSS 凭据);无服务端项目的环境才需要 OSS 四项(填入技能仓库 `.env` 或系统环境变量):
|
|
|
|
|
|
|
|
| 环境变量 | 必填 | 取值来源 | 说明 |
|
|
| 环境变量 | 必填 | 取值来源 | 说明 |
|
|
|
|---|---|---|---|
|
|
|---|---|---|---|
|
|
|
| `SMARTBADGE_API_BASE` | 否 | 线上 `https://recording.sh-lami.com` | 或本机后端 `http://localhost:3002` |
|
|
| `SMARTBADGE_API_BASE` | 否 | 线上 `https://recording.sh-lami.com` | 或本机后端 `http://localhost:3002` |
|
|
|
| `SMARTBADGE_USERNAME` | 否 | 登录用户名 | 脚本默认 `lami123456` |
|
|
| `SMARTBADGE_USERNAME` | 否 | 登录用户名 | 脚本默认 `lami123456` |
|
|
|
| `SMARTBADGE_PASSWORD` | **是** | API 登录密码(与系统一致) | 唯一必需项 |
|
|
| `SMARTBADGE_PASSWORD` | **是** | API 登录密码(与系统一致) | 唯一必需项 |
|
|
|
-| `OSS_ACCESS_KEY_ID` | 条件 | 本机免配:自动发现 `server/.env` | 仅跨机需导出 |
|
|
|
|
|
-| `OSS_ACCESS_KEY_SECRET` | 条件 | 同上 | 仅跨机需导出 |
|
|
|
|
|
-| `OSS_REGION` | 条件 | 同上(如 `oss-cn-shanghai`) | 仅跨机需导出 |
|
|
|
|
|
-| `OSS_BUCKET` | 条件 | 同上 | 仅跨机需导出 |
|
|
|
|
|
|
|
+| `OSS_ACCESS_KEY_ID` | 条件 | 自动发现服务端项目 `server/.env`;无则填入技能仓库 `.env` | 需 OSS 对账时才需要 |
|
|
|
|
|
+| `OSS_ACCESS_KEY_SECRET` | 条件 | 同上 | 需 OSS 对账时才需要 |
|
|
|
|
|
+| `OSS_REGION` | 条件 | 同上(如 `oss-cn-shanghai`) | 同上 |
|
|
|
|
|
+| `OSS_BUCKET` | 条件 | 同上 | 同上 |
|
|
|
|
|
|
|
|
**步骤 3**:给 AI 的完整提示词模板(复制粘贴,替换 `<...>` 占位):
|
|
**步骤 3**:给 AI 的完整提示词模板(复制粘贴,替换 `<...>` 占位):
|
|
|
|
|
|
|
@@ -76,8 +82,8 @@ cmd /c mklink /D "%USERPROFILE%\.claude\skills\smartbadge-ops" "本仓库路径"
|
|
|
SMARTBADGE_API_BASE=https://recording.sh-lami.com
|
|
SMARTBADGE_API_BASE=https://recording.sh-lami.com
|
|
|
SMARTBADGE_USERNAME=lami123456
|
|
SMARTBADGE_USERNAME=lami123456
|
|
|
SMARTBADGE_PASSWORD=<填 API 登录密码>
|
|
SMARTBADGE_PASSWORD=<填 API 登录密码>
|
|
|
-# 本机: OSS 四项免配,技能自动发现项目 server/.env
|
|
|
|
|
-# 跨机: 手工导出 OSS_ACCESS_KEY_ID/OSS_ACCESS_KEY_SECRET/OSS_REGION/OSS_BUCKET
|
|
|
|
|
|
|
+# 有服务端项目同机: OSS 四项免配,技能自动发现项目 server/.env
|
|
|
|
|
+# 无服务端项目: 在技能仓库 .env 填 OSS_ACCESS_KEY_ID/OSS_ACCESS_KEY_SECRET/OSS_REGION/OSS_BUCKET
|
|
|
## 使用规范
|
|
## 使用规范
|
|
|
按 SKILL.md §1 确认门协议执行: 先复述我的问题与方案,回问「是这个意思吗?」;
|
|
按 SKILL.md §1 确认门协议执行: 先复述我的问题与方案,回问「是这个意思吗?」;
|
|
|
只读操作(巡检/列表/对账/聚合)可一句备案继续;写操作(补跑/重试/补传/改配置)必须先罗列将修改的数据面并等我确认。
|
|
只读操作(巡检/列表/对账/聚合)可一句备案继续;写操作(补跑/重试/补传/改配置)必须先罗列将修改的数据面并等我确认。
|