@clawmover/cli 0.0.1 → 0.0.2

package/README.md

@@ -1,25 +1,25 @@
 # @clawmover/cli
 
-OpenClaw 数据备份和恢复命令行工具。
+Command-line tool for OpenClaw data backup and recovery.
 
-## 功能特性
+## Features
 
-- 🔄 **自动备份**: 将 OpenClaw 数据备份到远程服务器
-- 📥 **数据恢复**: 从服务器快速恢复数据到本地
-- 🔒 **数据加密**: 使用 data-secret-key 加密所有备份数据
-- ⚡ **增量备份**: 基于 restic 的增量备份，节省存储空间
-- 🏷️ **标签管理**: 使用标签组织和筛选备份
-- ⚖️ **冲突处理**: 多种策略处理文件冲突
-- 📊 **进度显示**: 实时显示备份和恢复进度
-- 🔍 **详细日志**: 完整的操作日志记录
+- 🔄 **Auto Backup**: Backup OpenClaw data to remote servers
+- 📥 **Data Recovery**: Quickly restore data from server to local
+- 🔒 **Data Encryption**: All backup data encrypted with data-secret-key
+- ⚡ **Incremental Backup**: Restic-based incremental backup saves storage
+- 🏷️ **Tag Management**: Organize and filter backups with tags
+- ⚖️ **Conflict Handling**: Multiple strategies for file conflicts
+- 📊 **Progress Display**: Real-time backup and restore progress
+- 🔍 **Detailed Logs**: Complete operation log records
 
-## 安装
+## Installation
 
 ```bash
 npm install -g @clawmover/cli
 ```
 
-或从源码安装:
+Or install from source:
 
 ```bash
 git clone https://github.com/clawmover/clawmover-cli.git
@@ -29,32 +29,32 @@ npm run build
 npm link
 ```
 
-## 配置
+## Configuration
 
-工具会自动读取 OpenClaw 配置文件，你也可以通过命令行参数覆盖:
+The tool automatically reads OpenClaw config file. You can also override via command-line options:
 
 ```bash
-# 查看配置文件路径
+# Show config file path
 openclaw config file
 ```
 
-## 使用方法
+## Usage
 
-### 备份数据
+### Backup Data
 
-基本备份命令:
+Basic backup command:
 
 ```bash
 clawmover backup
 ```
 
-指定实例 ID 和密钥:
+Specify instance ID and key:
 
 ```bash
 clawmover backup --instance-id your-instance-id --data-secret-key your-secret-key
 ```
 
-高级选项:
+Advanced options:
 
 ```bash
 clawmover backup \
@@ -67,38 +67,38 @@ clawmover backup \
   --log-level debug
 ```
 
-**参数说明:**
+**Options:**
 
-- `--instance-id <id>`: 实例 ID (覆盖配置文件)
-- `--data-secret-key <key>`: 数据密钥 (覆盖配置文件)
-- `--tags <tags>`: 逗号分隔的标签列表
-- `--conflict-strategy <strategy>`: 冲突处理策略 (smart|interactive|overwrite)，默认: smart
-- `--skip-temp`: 跳过临时文件
-- `--skip-cache`: 跳过缓存文件
-- `--storage-path <path>`: 自定义存储路径
-- `--log-level <level>`: 日志级别 (debug|info|warn|error)
+- `--instance-id <id>`: Instance ID (override config file)
+- `--data-secret-key <key>`: Data secret key (override config file)
+- `--tags <tags>`: Comma-separated tag list
+- `--conflict-strategy <strategy>`: Conflict strategy (smart|interactive|overwrite), default: smart
+- `--skip-temp`: Skip temporary files
+- `--skip-cache`: Skip cache files
+- `--storage-path <path>`: Custom storage path
+- `--log-level <level>`: Log level (debug|info|warn|error)
 
-### 恢复数据
+### Restore Data
 
-基本恢复命令:
+Basic restore command:
 
 ```bash
 clawmover restore
 ```
 
-指定快照 ID:
+Specify snapshot ID:
 
 ```bash
 clawmover restore --snapshot-id abc123
 ```
 
-按标签筛选:
+Filter by tags:
 
 ```bash
 clawmover restore --tags core,imessage-db
 ```
 
-高级选项:
+Advanced options:
 
 ```bash
 clawmover restore \
@@ -111,178 +111,178 @@ clawmover restore \
   --log-level info
 ```
 
-**参数说明:**
+**Options:**
 
-- `--instance-id <id>`: 实例 ID (覆盖配置文件)
-- `--data-secret-key <key>`: 数据密钥 (覆盖配置文件)
-- `--snapshot-id <id>`: 要恢复的快照 ID (默认: 最新)
-- `--tags <tags>`: 逗号分隔的标签，用于筛选快照
-- `--conflict-strategy <strategy>`: 冲突处理策略 (smart|interactive|overwrite)，默认: smart
-- `--target-path <path>`: 恢复的目标目录
-- `--log-level <level>`: 日志级别 (debug|info|warn|error)
+- `--instance-id <id>`: Instance ID (override config file)
+- `--data-secret-key <key>`: Data secret key (override config file)
+- `--snapshot-id <id>`: Snapshot ID to restore (default: latest)
+- `--tags <tags>`: Comma-separated tags to filter snapshots
+- `--conflict-strategy <strategy>`: Conflict strategy (smart|interactive|overwrite), default: smart
+- `--target-path <path>`: Target directory for restoration
+- `--log-level <level>`: Log level (debug|info|warn|error)
 
-## 冲突处理策略
+## Conflict Handling Strategies
 
-### Smart (智能处理，推荐)
+### Smart (Recommended)
 
-- **配置文件**: 询问用户如何处理
-- **数据库**: 自动备份旧版本
-- **附件**: 重命名本地文件
-- **普通文件**: 比较修改时间，保留较新的
+- **Config files**: Ask user for decision
+- **Database**: Auto backup old version
+- **Attachments**: Rename local file
+- **Regular files**: Compare modification time, keep newer
 
-### Interactive (交互式处理)
+### Interactive
 
-每个冲突都会询问用户选择:
-- 备份现有文件并覆盖
-- 重命名现有文件
-- 跳过此文件
-- 直接覆盖
+Ask user for each conflict:
+- Backup existing file and overwrite
+- Rename existing file
+- Skip this file
+- Overwrite directly
 
-### Overwrite (自动覆盖)
+### Overwrite
 
-直接覆盖所有冲突文件，不进行备份
+Overwrite all conflicting files without backup
 
-## 备份计划
+## Backup Plan
 
-工具会自动生成备份计划，包含以下数据类型:
+The tool automatically generates backup plan with these data types:
 
-1. **Core 数据** (必需)
-   - OpenClaw 核心配置和数据
-   - 标签: `core`
+1. **Core Data** (Required)
+   - OpenClaw core config and data
+   - Tag: `core`
 
-2. **iMessage 数据库** (可选)
-   - 如果配置了 `imessageDb`
-   - 标签: `imessage-db`, `core`
+2. **iMessage Database** (Optional)
+   - If `imessageDb` is configured
+   - Tags: `imessage-db`, `core`
 
-3. **iMessage 附件** (可选)
-   - 如果配置了 `imessageAttachments`
-   - 标签: `imessage-attachments`, `core`
+3. **iMessage Attachments** (Optional)
+   - If `imessageAttachments` is configured
+   - Tags: `imessage-attachments`, `core`
 
-4. **Sandbox 数据** (可选)
-   - 沙箱环境数据
-   - 标签: `sandbox`
+4. **Sandbox Data** (Optional)
+   - Sandbox environment data
+   - Tag: `sandbox`
 
-5. **缓存数据** (可选)
-   - 应用缓存
-   - 标签: `cache`
+5. **Cache Data** (Optional)
+   - Application cache
+   - Tag: `cache`
 
-6. **临时文件** (可选)
-   - 临时文件
-   - 标签: `temp`
+6. **Temporary Files** (Optional)
+   - Temporary files
+   - Tag: `temp`
 
-## 标签系统
+## Tag System
 
-使用标签可以更好地组织和筛选备份:
+Use tags to organize and filter backups:
 
 ```bash
-# 创建带标签的备份
+# Create backup with tags
 clawmover backup --tags production,daily
 
-# 恢复特定标签的数据
+# Restore specific tagged data
 clawmover restore --tags production
 
-# 查看特定实例的所有备份
+# List all backups for an instance
 clawmover list --instance-id your-instance-id
 ```
 
-自动添加的标签:
-- `instance:<instanceId>`: 实例 ID
-- `date:<YYYY-MM-DD>`: 备份日期
+Auto-added tags:
+- `instance:<instanceId>`: Instance ID
+- `date:<YYYY-MM-DD>`: Backup date
 
-## 日志和调试
+## Logging and Debugging
 
-设置日志级别:
+Set log level:
 
 ```bash
-# 详细调试信息
+# Verbose debug info
 clawmover backup --log-level debug
 
-# 只显示错误
+# Errors only
 clawmover backup --log-level error
 ```
 
-日志文件默认保存在 `./logs/clawmover.log`。
+Log file is saved to `./logs/clawmover.log` by default.
 
-## 开发
+## Development
 
-### 项目结构
+### Project Structure
 
 ```
 @clawmover/cli/
 ├── src/
-│   ├── commands/          # 命令执行层
-│   ├── services/          # 核心服务层
-│   ├── integrations/      # 外部集成层
-│   ├── system/            # 系统服务层
-│   ├── types/             # 类型定义
-│   ├── utils/             # 工具函数
-│   └── index.ts           # 入口文件
-├── tests/                 # 测试文件
+│   ├── commands/          # Command execution layer
+│   ├── services/          # Core service layer
+│   ├── integrations/      # External integration layer
+│   ├── system/            # System service layer
+│   ├── types/             # Type definitions
+│   ├── utils/             # Utility functions
+│   └── index.ts           # Entry point
+├── tests/                 # Test files
 ├── package.json
 ├── tsconfig.json
 └── README.md
 ```
 
-### 构建
+### Build
 
 ```bash
 npm run build
 ```
 
-### 测试
+### Test
 
 ```bash
-# 运行所有测试
+# Run all tests
 npm test
 
-# 监视模式
+# Watch mode
 npm run test:watch
 
-# 覆盖率报告
+# Coverage report
 npm run test:coverage
 ```
 
-### 代码质量
+### Code Quality
 
 ```bash
 # Lint
 npm run lint
 
-# 自动修复
+# Auto fix
 npm run lint:fix
 
-# 格式化代码
+# Format code
 npm run format
 ```
 
-## 故障排除
+## Troubleshooting
 
-### 备份失败
+### Backup Failed
 
-1. 检查网络连接
-2. 验证 `data-secret-key` 是否正确
-3. 查看日志文件获取详细错误信息
+1. Check network connection
+2. Verify `data-secret-key` is correct
+3. Check log file for detailed error info
 
-### 恢复失败
+### Restore Failed
 
-1. 确认快照 ID 存在
-2. 检查目标目录权限
-3. 验证 `data-secret-key` 是否与备份时相同
+1. Confirm snapshot ID exists
+2. Check target directory permissions
+3. Verify `data-secret-key` matches the backup
 
-### 找不到 OpenClaw 配置
+### OpenClaw Config Not Found
 
-运行以下命令检查配置文件位置:
+Run this command to check config file location:
 
 ```bash
 openclaw config file
 ```
 
-## 许可证
+## License
 
 MIT
 
-## 支持
+## Support
 
-如有问题或建议，请访问:
+For issues or suggestions, visit:
 - GitHub Issues: https://github.com/clawmover/clawmover-cli/issues
-- 文档: https://github.com/clawmover/clawmover-cli#readme
+- Documentation: https://github.com/clawmover/clawmover-cli#readme