ai-yuca 1.1.1 → 1.1.2

package/README.md

@@ -10,71 +10,371 @@ npm install -g ai-yuca
 
 ## 使用方法
 
+### 分析文本
+
 ```bash
-ai-yuca <命令> [选项]
+# 分析文件
+ai-yuca analyze -f path/to/file.txt
+
+# 分析文本
+ai-yuca analyze -t "要分析的文本内容"
 ```
 
-### 可用命令
+### 文件上传
+
+```bash
+# 上传文件到GCP存储桶
+ai-yuca upload -s ./dist -b my-bucket -d static/app
 
-- `help`: 显示帮助信息
-- `version`: 显示版本信息
-- `analyze`: 分析文本内容
-- `upload`: 上传文件到GCP存储桶
+# 基于配置文件上传
+ai-yuca upload-config
+```
 
-### 示例
+### 文件下载
 
 ```bash
-# 分析文本文件
-ai-yuca analyze --file example.txt
+# 从GCP存储桶下载文件
+ai-yuca download -s static/app -b my-bucket -d ./downloads
+```
 
-# 上传单个文件到GCP存储桶（使用密钥文件）
-ai-yuca upload --source path/to/file.txt --bucket your-bucket-name --key-file path/to/keyfile.json
+### 部署
 
-# 使用应用默认凭证免密上传（需先设置GOOGLE_APPLICATION_CREDENTIALS环境变量）
-ai-yuca upload --source path/to/file.txt --bucket your-bucket-name
+```bash
+# 部署到指定环境
+ai-yuca deploy -e test
+
+# 部署到生产环境
+ai-yuca deploy -e production
+```
 
-# 批量上传多个文件
-ai-yuca upload --source file1.txt file2.txt file3.txt --bucket your-bucket-name --key-file path/to/keyfile.json
+### 初始化配置
 
-# 递归上传目录中的所有文件
-ai-yuca upload --source path/to/directory --bucket your-bucket-name --key-file path/to/keyfile.json --recursive
+```bash
+# 生成配置文件
+ai-yuca init
 ```
 
-## 特性
+## 可用命令
 
-- 简单易用的命令行界面
-- 强大的文本分析功能
-- GCP文件上传功能，支持批量和递归上传
-- 支持多种GCP认证方式，包括密钥文件和应用默认凭证（免密上传）
-- 完整的TypeScript类型支持
-- 可扩展的插件系统
+### `analyze` - 分析文本内容
+- `-f, --file <path>` - 指定要分析的文件路径
+- `-t, --text <text>` - 直接分析提供的文本
 
-## 开发
+### `upload` - 上传文件到GCP存储桶
+- `-s, --source <paths...>` - 指定要上传的文件或目录路径（支持多个）
+- `-b, --bucket <name>` - GCP存储桶名称
+- `-d, --destination <path>` - 目标路径（存储桶中的路径）
+- `-k, --key-file <path>` - GCP服务账号密钥文件路径（可选）
+- `-r, --recursive` - 递归上传目录中的文件
+- `-c, --no-compression` - 禁用GZIP压缩
 
-### 安装依赖
+### `download` - 从GCP存储桶下载文件或文件夹
+- `-s, --source <path>` - 指定要下载的GCP存储桶中的文件或目录路径
+- `-b, --bucket <name>` - GCP存储桶名称
+- `-d, --destination <path>` - 本地目标路径
+- `-k, --key-file <path>` - GCP服务账号密钥文件路径（可选）
+- `-r, --recursive` - 递归下载目录中的文件
 
+### `upload-config` - 基于vs.config.json配置文件上传文件
+- `-c, --config <path>` - 指定配置文件路径（默认为vs.config.json）
+- `-k, --key-file <path>` - GCP服务账号密钥文件路径（可选）
+- `-s, --source <path>` - 自定义源路径（覆盖配置文件中的uploadPath）
+- `-d, --destination <path>` - 自定义目标路径
+- `--no-recursive` - 禁用递归上传
+- `--no-compression` - 禁用GZIP压缩
+- `--no-cache` - 禁用文件缓存功能
+- `--cache-file <path>` - 指定缓存文件路径
+- `--show-config` - 仅显示配置信息，不执行上传
+
+### `deploy` - 部署文件到指定环境
+- `-e, --env <environment>` - 部署环境（如：dev、test、production）**（必需）**
+- `-c, --config <path>` - 指定配置文件路径（默认为vs.config.json）
+- `-k, --key-file <path>` - GCP服务账号密钥文件路径（可选）
+- `-s, --source <path>` - 自定义源路径
+- `-d, --destination <path>` - 自定义目标路径
+- `--no-recursive` - 禁用递归上传
+- `--no-compression` - 禁用GZIP压缩
+- `--no-cache` - 禁用文件缓存功能
+- `--cache-file <path>` - 指定缓存文件路径
+- `--show-config` - 仅显示配置信息，不执行部署
+- `-f, --force` - 强制执行，跳过交互式确认
+
+### `init` - 在当前目录生成vs.config.json配置文件
+- `-f, --force` - 强制覆盖已存在的配置文件
+
+## 示例
+
+### 文本分析
 ```bash
-npm install
+# 分析文件内容
+ai-yuca analyze --file ./example.txt
+
+# 分析指定文本
+ai-yuca analyze --text "这是一段需要分析的文本"
 ```
 
-### 构建
+### 文件上传
+```bash
+# 上传单个文件
+ai-yuca upload -s ./dist/index.html -b my-bucket -d static/app/
+
+# 上传整个目录（递归）
+ai-yuca upload -s ./dist -b my-bucket -d static/app/ -r
+
+# 上传多个文件/目录
+ai-yuca upload -s ./dist ./assets -b my-bucket -d static/app/ -r
+
+# 使用服务账号密钥文件
+ai-yuca upload -s ./dist -b my-bucket -d static/app/ -k ./service-account.json
+```
 
+### 基于配置文件的上传
 ```bash
-npm run build
+# 使用默认配置文件
+ai-yuca upload-config
+
+# 使用自定义配置文件
+ai-yuca upload-config -c ./custom-config.json
+
+# 覆盖配置文件中的源路径
+ai-yuca upload-config -s ./build
+
+# 仅显示配置信息
+ai-yuca upload-config --show-config
 ```
 
-### 开发模式运行
+### 文件下载
+```bash
+# 下载单个文件
+ai-yuca download -s static/app/index.html -b my-bucket -d ./downloads/
 
+# 递归下载整个目录
+ai-yuca download -s static/app/ -b my-bucket -d ./downloads/ -r
+```
+
+### 部署
 ```bash
-npm run dev
+# 部署到测试环境
+ai-yuca deploy -e test
+
+# 部署到生产环境
+ai-yuca deploy -e production
+
+# 强制部署（跳过确认）
+ai-yuca deploy -e test -f
+
+# 仅显示部署配置
+ai-yuca deploy -e test --show-config
 ```
 
-### 运行测试
+### 初始化配置
+```bash
+# 生成默认配置文件
+ai-yuca init
+
+# 强制覆盖已存在的配置文件
+ai-yuca init -f
+```
+
+## 配置文件
+
+### vs.config.json 结构
+
+使用 `ai-yuca init` 命令可以生成默认的配置文件，结构如下：
+
+```json
+{
+  "upload": {
+    "uploadPath": "out",
+    "s3Static": "static/aiAgent"
+  },
+  "deploy": {
+    "baseUrl": [
+      "/",
+      "en-us/",
+      "zh-cn/",
+      "de-de/",
+      "it-it/",
+      "pt-pt/",
+      "es-es/",
+      "fr-fr/",
+      "ru-ru/",
+      "error/",
+      "download-v2/"
+    ],
+    "host": "",
+    "testHost": ""
+  },
+  "aws": {
+    "Bucket": "cdn",
+    "prefix": "fed",
+    "Region": "us-east-1",
+    "HostName": ""
+  },
+  "crowdin": {
+    "project": "project",
+    "langMap": ["zh-cn"],
+    "workDir": "src",
+    "reg": "{#(.+?)#}",
+    "keysDir": "src/_i18n",
+    "Bucket": "cdn",
+    "prefix": "fed",
+    "Region": "us-east-1",
+    "FromIni": "mall",
+    "HostName": ""
+  }
+}
+```
+
+### 配置说明
+
+- **upload.uploadPath**: 默认上传的本地源路径
+- **upload.s3Static**: 存储桶中的目标路径
+- **deploy.baseUrl**: 部署时支持的基础URL列表
+- **deploy.host**: 生产环境主机地址
+- **deploy.testHost**: 测试环境主机地址
+- **aws.Bucket**: GCP存储桶名称
+- **aws.prefix**: 存储桶中的前缀路径
+- **aws.Region**: 存储桶区域
+- **aws.HostName**: CDN主机名
+
+## 特性
+
+- 🔍 **文本分析**: 支持文件和直接文本分析
+- ☁️ **云存储**: 支持上传/下载文件到Google Cloud Storage
+- 🔐 **安全认证**: 支持服务账号密钥文件和应用默认凭证
+- 📁 **批量操作**: 支持批量上传多个文件和递归上传目录
+- 🚀 **高性能**: 使用Promise.all并行处理，提升上传/下载效率
+- 🎨 **彩色输出**: 成功绿色、失败红色、跳过黄色的彩色终端输出
+- ⚙️ **配置驱动**: 支持基于vs.config.json配置文件的操作
+- 🗜️ **智能压缩**: 自动对js、css、json、html、woff文件启用GZIP压缩
+- 📦 **部署功能**: 支持多环境部署（dev、test、production）
+- 💾 **缓存机制**: 支持文件缓存，避免重复上传相同文件
+- 🔧 **灵活配置**: 支持命令行参数覆盖配置文件设置
+- 🛠️ **TypeScript**: 完整的TypeScript类型支持
+- 🔌 **可扩展**: 可扩展的插件系统
+
+## 开发
+
+### 环境要求
+
+- Node.js >= 14.0.0
+- npm >= 6.0.0
+- TypeScript >= 4.0.0
+
+### 开发设置
 
 ```bash
+# 克隆项目
+git clone <repository-url>
+cd ai-yuca
+
+# 安装依赖
+npm install
+
+# 构建项目
+npm run build
+
+# 运行测试
 npm test
+
+# 开发模式（监听文件变化）
+npm run dev
+```
+
+### 项目结构
+
+```
+ai-yuca/
+├── bin/                 # CLI入口文件
+│   └── cli.ts          # 命令行接口定义
+├── src/                # 源代码
+│   ├── index.ts        # 主入口
+│   ├── upload.ts       # 上传功能
+│   ├── download.ts     # 下载功能
+│   ├── deploy.ts       # 部署功能
+│   ├── uploadWithConfig.ts # 配置文件上传
+│   └── types.ts        # TypeScript类型定义
+├── dist/               # 编译输出
+├── package.json        # 项目配置
+└── README.md          # 项目文档
+```
+
+### 贡献指南
+
+1. Fork 项目
+2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 打开 Pull Request
+
+### 发布流程
+
+```bash
+# 更新版本号
+npm version patch|minor|major
+
+# 构建项目
+npm run build
+
+# 发布到npm
+npm publish
 ```
 
+## 常见问题
+
+### Q: 如何设置GCP认证？
+
+A: 有两种方式：
+1. 使用服务账号密钥文件：`-k path/to/service-account.json`
+2. 使用应用默认凭证：设置环境变量 `GOOGLE_APPLICATION_CREDENTIALS`
+
+### Q: 上传失败怎么办？
+
+A: 检查以下几点：
+1. 确认GCP认证配置正确
+2. 确认存储桶名称和权限
+3. 检查网络连接
+4. 查看详细错误信息
+
+### Q: 如何自定义压缩设置？
+
+A: 使用 `--no-compression` 参数禁用压缩，或在配置文件中设置相关选项。
+
+### Q: 支持哪些文件类型的压缩？
+
+A: 默认对以下文件类型启用GZIP压缩：
+- JavaScript (.js)
+- CSS (.css)
+- JSON (.json)
+- HTML (.html)
+- Web字体 (.woff)
+
+## 更新日志
+
+### v1.0.0
+- 🎉 初始版本发布
+- ✨ 支持文本分析功能
+- ✨ 支持GCP存储桶上传/下载
+- ✨ 支持配置文件驱动的操作
+- ✨ 支持多环境部署
+- ✨ 支持并行处理和彩色输出
+
 ## 许可证
 
-MIT
+MIT License - 详见 [LICENSE](LICENSE) 文件
+
+## 联系方式
+
+- 作者：[Your Name]
+- 邮箱：[your.email@example.com]
+- 项目主页：[https://github.com/yourusername/ai-yuca]
+- 问题反馈：[https://github.com/yourusername/ai-yuca/issues]
+
+## 致谢
+
+感谢所有贡献者和开源社区的支持！
+
+---
+
+**如果这个项目对您有帮助，请给我们一个 ⭐️！**

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "ai-yuca",
-    "version": "1.1.1",
-    "description": "一个实用的AI辅助工具",
+    "version": "1.1.2",
+    "description": "一个用AI生成的开发辅助工具",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "bin": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ai-yuca",
-  "version": "1.1.1",
-  "description": "一个实用的AI辅助工具",
+  "version": "1.1.2",
+  "description": "一个用AI生成的开发辅助工具",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "bin": {