0.7.16 - 手册

Author: netkiller

doc/dingtalk.md

@@ -1 +1,119 @@
-# 钉钉工具
+钉钉消息推送
+===========
+
+## 简介
+
+dingtalk 是一个用于向钉钉群发送消息的工具脚本。通过钉钉自定义机器人 Webhook 接口，可以推送文本和 Markdown 格式的消息。
+
+## 准备工作
+
+### 创建钉钉机器人
+
+1. 打开钉钉群设置
+2. 进入「智能群助手」
+3. 添加机器人
+4. 选择「自定义」机器人
+5. 配置机器人名称和安全设置（推荐使用「加签」方式）
+6. 复制 `access_token` 和 `secret`
+
+## 使用方法
+
+### 基本语法
+
+```bash
+dingtalk [options] message
+```
+
+### 命令行选项
+
+| 选项 | 说明 |
+|------|------|
+| `-t Token` | 设置 access_token（必填） |
+| `-s Secret` | 设置密钥（加签模式） |
+| `-l File` | 日志文件路径（默认 /var/tmp/dingtalk.log） |
+| `--stdin` | 从标准输入读取消息内容 |
+| `--text` | 发送文本消息（默认） |
+| `--markdown` | 发送 Markdown 格式消息 |
+| `--title Title` | Markdown 消息标题 |
+| `-d` | 开启调试模式 |
+
+## 使用示例
+
+### 发送文本消息
+
+```bash
+dingtalk -t 你的access_token "Hello World"
+```
+
+### 发送加签消息
+
+```bash
+dingtalk -t 你的access_token -s 你的secret "这是一条加签消息"
+```
+
+### 发送 Markdown 消息
+
+```bash
+dingtalk -t 你的access_token --markdown --title "标题" "## Markdown 内容"
+```
+
+### 从管道读取消息
+
+```bash
+echo "消息内容" | dingtalk -t 你的access_token --stdin
+```
+
+### 发送日志片段
+
+```bash
+tail -20 /var/log/syslog | dingtalk -t 你的access_token --stdin --text
+```
+
+## 消息格式
+
+### 文本消息（Text）
+
+普通文本内容，直接显示在聊天窗口。
+
+```
+这是一条普通文本消息
+```
+
+### Markdown 消息
+
+支持标准 Markdown 格式，适合展示结构化内容。
+
+示例：
+```markdown
+## 告警通知
+
+- 服务器：web-01
+- CPU 使用率：85%
+- 内存使用率：90%
+
+> 请及时处理
+```
+
+支持的 Markdown 元素：
+- 标题（#-######）
+- 加粗、斜体
+- 链接
+- 图片
+- 列表
+- 引用块
+- 代码块
+
+## 日志
+
+默认日志文件：`/var/tmp/dingtalk.log`
+
+日志记录内容：
+- 发送的请求数据
+- 接口响应结果
+
+## 注意事项
+
+1. **access_token 必填** - 不提供则程序报错退出
+2. **加签更安全** - 生产环境建议配合 `-s secret` 使用加签验证
+3. **消息长度限制** - 钉钉对消息长度有限制，过长消息可能发送失败
+4. **日志权限** - 写入 `/var/tmp/dingtalk.log` 需要相应权限

doc/exceldiff.md

@@ -0,0 +1,96 @@
+# ExcelDiff
+
+Excel 文件对比工具，用于比较两个 Excel 文件的内容差异。
+
+## 安装依赖
+
+```bash
+pip3 install pandas openpyxl
+```
+
+## 命令行选项
+
+| 选项 | 说明 |
+|------|------|
+| `-f` | 对比所有工作表 |
+| `-s Sheet` | 指定要对比的工作表名称 |
+| `-d` | 调试模式 |
+
+## 使用方法
+
+### 基本语法
+
+```bash
+exceldiff [options] <file1.xlsx> <file2.xlsx>
+```
+
+### 显示文件 MD5
+
+```bash
+exceldiff file1.xlsx file2.xlsx
+```
+
+会先显示两个文件的 MD5 值，如果 MD5 相同说明文件完全相同。
+
+### 对比所有工作表
+
+```bash
+exceldiff -f file1.xlsx file2.xlsx
+```
+
+对比两个文件中的所有工作表，逐一显示每个工作表的差异。
+
+### 对比指定工作表
+
+```bash
+exceldiff -s Sheet1 file1.xlsx file2.xlsx
+```
+
+仅对比指定名称的工作表。
+
+## 输出示例
+
+```
+======================================== md5sum ========================================
+/usr/bin/md5sum file1.xlsx file2.xlsx
+d41d8cd98f00b204e9800998ecf8427e  file1.xlsx
+d41d8cd98f00b204e9800998ecf8427e  file2.xlsx
+
+======================================== file1.xlsx <=> file2.xlsx ========================================
+['Sheet1', 'Sheet2', 'Sheet3']
+
+======================================== 工作表 [Sheet1] 对比结果 =========================================
+```
+
+## 差异显示格式
+
+差异行以以下格式显示：
+
+```
+行号1 内容1    |    行号1 内容2    # 差异行，左侧来自文件1，右侧来自文件2
+行号2 内容1    <    行号2 内容2    # 左侧缺少的行
+行号3 内容3    >    行号3 内容4    # 右侧缺少的行
+```
+
+无差异的行不会显示。
+
+## 工作原理
+
+1. 计算并显示两个 Excel 文件的 MD5 值
+2. 使用 pandas 读取 Excel 文件内容
+3. 将指定工作表转换为 CSV 格式保存到临时文件
+4. 使用 `sdiff` 命令对比两个 CSV 文件
+
+## 注意事项
+
+- 需要两个文件名作为位置参数
+- 支持 `.xlsx` 格式
+- 第一列作为索引列（index_col=0）
+- 仅支持 macOS 和 Linux 系统
+- 临时 CSV 文件保存在 `/tmp/` 目录
+
+## 适用场景
+
+- 对比配置变更前后 Excel 表格的差异
+- 检查数据导入导出是否一致
+- 核对两个版本的报表差异

doc/gitsync.md

@@ -1,3 +1,77 @@
 GIT Sync
 ========
 
+## 简介
+
+gitsync 是一个用于同步多个 Git 仓库的工具脚本。它从 `~/workspace/git.ini` 读取配置，实现以下功能：
+
+- 从 origin 克隆仓库
+- 配置多个 remote
+- 同步主分支到所有 remote
+
+## 工作流程
+
+1. 读取 `~/workspace/git.ini` 配置文件
+2. 遍历每个配置节（section）
+3. 根据配置执行相应的 Git 操作
+
+## 配置文件
+
+配置文件位于 `~/workspace/git.ini`，采用 INI 格式。
+
+### 配置项
+
+| 配置项 | 说明 |
+|--------|------|
+| `origin` | Git 仓库地址（克隆源） |
+| `remote` | 远程仓库名称，多个用逗号分隔 |
+
+### 配置示例
+
+```ini
+[project1]
+origin = git@github.com:username/repo1.git
+remote = upstream,gitlab
+
+[project2]
+origin = git@gitlab.com:team/repo2.git
+remote = github,bitbucket
+```
+
+### 路径说明
+
+- 工作目录：`~/workspace/`
+- 仓库目录：`~/workspace/{source}/`，其中 `source` 是从 origin URL 中提取的仓库名
+
+## 使用方法
+
+```bash
+./bin/gitsync
+```
+
+或
+
+```bash
+python3 bin/gitsync
+```
+
+## 操作逻辑
+
+### 新仓库（不存在）
+
+1. 从 origin 克隆仓库到 `~/workspace/{仓库名}/`
+2. 添加配置的 remote
+
+### 已存在仓库
+
+1. 进入仓库目录
+2. 执行 `git reset --hard` 重置工作区
+3. 执行 `git pull origin` 拉取最新代码
+4. 遍历所有非 origin 的 remote，执行 `git push {remote} master`
+
+## 注意事项
+
+- 脚本假设所有仓库的默认分支为 `master`
+- 使用 `git pull origin` 直接拉取，不处理冲突
+- `git reset --hard` 会丢弃所有未提交的更改
+- 需要确保 SSH key 已配置到对应的 Git 服务商