@cnbcool/cnb-cli 1.0.0 → 1.0.1

package/skills/cnb-code-import/SKILL.md

@@ -1,368 +0,0 @@
----
-name: cnb-code-import
-description: 批量迁移代码仓库到 CNB 平台。支持从 CODING、GitHub、GitLab、Gitee、阿里云 Codeup、华为云 CodeArts、腾讯工蜂、Gitea 等主流平台迁移。使用 docker 运行 cnbcool/code-import 镜像自动完成迁移。
----
-
-# CNB Code Import Skill
-
-帮助用户批量迁移代码仓库到 CNB 平台。
-
-## 环境依赖
-
-**必须安装 Docker**。检查命令：
-
-```bash
-docker --version
-```
-
-如未安装，请参考 [Docker 官方安装文档](https://docs.docker.com/get-docker/) 或使用一键脚本：
-
-```bash
-# Linux
-curl -fsSL https://get.docker.com | bash
-systemctl start docker
-
-# macOS
-brew install --cask docker && open /Applications/Docker.app
-
-# Windows
-winget install -e --id Docker.DockerDesktop
-```
-
-> 💡 **提示**：macOS 和 Windows 上 Docker Desktop 安装后会自动管理服务，无需手动启动。Linux 上如需免 sudo 运行，可执行 `sudo usermod -aG docker $USER` 后重新登录。
-
-## 工作目录
-
-迁移脚本会在家目录的 `code-import-workspace` 目录执行，包括：
-
-- 克隆源仓库的临时文件
-- 迁移日志 `successful.log`（已迁移成功的仓库记录）
-- 可选的 `repo-path.txt`（手动选择迁移的仓库列表）
-
-**自动创建：** 首次运行迁移时会自动创建该目录
-
-**手动创建：**
-```bash
-mkdir -p ~/code-import-workspace
-```
-
-## 何时使用
-
-当用户需要：
-- 从其他代码托管平台迁移仓库到 CNB
-- 批量迁移多个仓库
-- 自动处理大文件（转 LFS）
-- 保留仓库历史提交记录
-
-**支持的平台：**
-- CODING（腾讯云开发者平台）
-- GitHub
-- GitLab
-- Gitee（码云）
-- 阿里云 Codeup（云效）
-- 华为云 CodeArts Repo
-- 腾讯工蜂
-- Gitea
-- CNB 之间互迁
-- 通用第三方平台（HTTP/SSH）
-
-## 核心参数
-
-迁移前需要收集以下信息：
-
-### 必填参数
-
-| 参数 | 说明 |
-|------|------|
-| `source_platform` | 源平台：`coding`/`github`/`gitlab`/`gitee`/`gitea`/`aliyun`/`huaweicloud`/`gongfeng`/`cnb`/`common` |
-| `source_token` | 源平台访问令牌（Token），`common` 平台使用 SSH 克隆时可不填 |
-| `cnb_org` | **目标平台** CNB 根组织名称（需提前创建） |
-| `cnb_token` | **目标平台** CNB 访问令牌（用于向 CNB 推送仓库，需要写入权限，与源平台 Token 不同） |
-
-### 可选参数
-
-> 💡 以下参数名使用下划线分隔，对应脚本参数为中划线格式（如 `source_repo` → `--source-repo`）。
-
-| 参数 | 说明 | 默认值 |
-|------|------|--------|
-| `source_repo` | 指定迁移的仓库（逗号分隔） | 全部 |
-| `source_project` | CODING 项目名称（migrate_type=project 时） | - |
-| `source_url` | 源平台 URL（Gitea/自建 GitLab 等自建实例必填） | 自动识别 |
-| `source_ak` | 华为云 AK（huaweicloud 平台必填） | - |
-| `source_sk` | 华为云 SK（huaweicloud 平台必填） | - |
-| `source_region` | 华为云区域 | `cn-north-4` |
-| `source_organizationid` | 阿里云组织 ID（aliyun 平台必填） | - |
-| `source_username` | 通用平台用户名（common 平台使用） | - |
-| `source_password` | 通用平台密码（common 平台使用） | - |
-| `source_group` | CNB 源组织名（CNB 之间互迁时使用） | - |
-| `migrate_type` | 迁移类型：`team`/`project`/`repo` | `team` |
-| `concurrency` | 并发数（最大 10） | `5` |
-| `force_push` | 强制覆盖 CNB 仓库 ⚠️ 危险，需二次确认 | `false` |
-| `skip_exists` | 跳过 CNB 已存在的仓库 | `false` |
-| `lfs_migrate` | 大文件转 LFS | `true` |
-| `download_only` | 只下载不推送 | `false` |
-| `allow_select_repos` | 生成 repo-path.txt 手动选择 | `false` |
-| `rebase` | 使用 git rebase 同步 ⚠️ 危险，需二次确认 | `false` |
-| `allow_incomplete_push` | 允许不完整推送 ⚠️ 危险，需二次确认 | `false` |
-| `log_level` | 日志级别：`debug`/`info`/`warn`/`error` | `info` |
-| `workspace` | 自定义工作目录 | `~/code-import-workspace` |
-
-## Token 权限要求
-
-### 目标平台 CNB Token（`cnb_token`，必填）
-
-所有迁移场景都需要提供目标平台 CNB 的访问令牌，用于向 CNB 推送仓库：
-
-- **权限要求**：勾选「常见场景 - 迁移工具凭据」即可快速完成授权（包含仓库创建和推送所需的写入权限）
-- **授权范围**：全部仓库/制品库
-- **到期时间**：按需选择，建议最小化
-- **创建地址**：https://cnb.cool/-/profile/tokens
-
-> ⚠️ **注意**：目标平台 CNB Token 需要**写入权限**（推送仓库），与下方「源平台 CNB Token」的只读权限不同。如果源平台恰好也是 CNB（CNB 之间互迁），需要分别创建两个不同权限的 Token。
-
-### 源平台 Token（`source_token`）
-
-不同源平台需要的 Token 权限及创建地址：
-
-- **CODING**：团队所有者或管理员，权限：用户信息 - 只读、项目信息 - 只读、代码仓库 - 只读
-  - 创建地址：https://e.coding.net/user/tokens/create
-- **GitHub**：`repo:all`、`read:org`（classic token）
-  - 创建地址：https://github.com/settings/tokens/new
-- **GitLab**：`read_api`
-  - 创建地址：https://gitlab.com/-/user_settings/personal_access_tokens（自建实例请替换域名）
-- **Gitee**：`user_info`、`projects`
-  - 创建地址：https://gitee.com/profile/personal_access_tokens
-- **阿里云**：代码仓库 - 只读
-  - 创建地址：https://account.aliyun.com/login/login.htm（通过云效控制台创建）
-- **CNB（作为源平台，互迁场景）**：`account-engage:r`、`group-resource:r`，授权范围：全部仓库/制品库（只读权限即可）
-  - 创建地址：https://cnb.cool/-/profile/tokens
-- **工蜂**：`api`、`read_repository`
-  - 创建地址：https://git.woa.com/-/profile/personal_access_tokens
-- **华为云**：仓库读写
-  - 创建地址：通过华为云 CodeArts 控制台创建 HTTPS 密码
-- **Gitea**：`read:organization`、`read:repository`、`read:user`
-  - 创建地址：`<Gitea实例地址>/user/settings/applications`
-
-## 工作流程
-
-1. **收集信息** → 询问用户源平台、源平台 Token、CNB 目标组织名、CNB 目标平台 Token
-2. **确认参数** → 复述配置让用户确认（特别注意：CNB 互迁时需分别提供源平台 Token 和目标平台 Token）
-3. **执行迁移** → 运行迁移脚本开始迁移
-4. **输出结果** → 显示迁移进度和结果
-
-### 执行方式
-
-通过项目中的 `scripts/migrate.sh` 脚本执行迁移：
-
-```bash
-bash scripts/migrate.sh \
-  --source-platform <platform> \
-  --source-token <token> \
-  --cnb-org <org> \
-  --cnb-token <token> \
-  [其他可选参数]
-```
-
-> ⚠️ **安全提示**：Token 属于敏感信息，建议通过环境变量传入而非硬编码在命令中。用户提供的 Token 不应被记录到日志或聊天记录中。
-
-### 错误处理
-
-迁移过程中可能遇到的错误及处理方式：
-
-- **Docker 未安装或未启动**：提示用户安装/启动 Docker 后重试
-- **Token 权限不足**：根据平台提示所需的具体权限，引导用户重新创建 Token
-- **网络超时**：建议用户检查网络连接，工具会自动重试 LFS 文件下载（最多 3 次）
-- **仓库已存在冲突**：建议开启 `--skip-exists true` 跳过，或确认后使用 `--force-push true`
-- **迁移中断**：再次执行相同命令即可，已成功的仓库会自动跳过（基于 `successful.log`）
-
-## 使用示例
-
-> 💡 以下示例展示用户与 AI 对话完成迁移的典型交互流程。AI 会引导用户提供必要信息，确认参数后执行迁移。
-
-### 示例 1：从 CODING 迁移全部仓库
-
-**用户**：帮我把 CODING 上的仓库迁移到 CNB
-
-**AI**：好的！从 CODING 迁移仓库到 CNB，我需要以下信息：
-
-1. **CODING Token**（源平台） — 需要团队所有者或管理员权限
-   - 权限要求：用户信息 - 只读、项目信息 - 只读、代码仓库 - 只读
-   - 创建地址：https://e.coding.net/user/tokens/create
-
-2. **CNB 目标组织名称** — 你在 cnb.cool 上的根组织名（需提前创建好）
-
-3. **CNB Token**（目标平台，用于推送仓库到 CNB）
-   - 权限要求：勾选「常见场景 - 迁移工具凭据」即可快速完成授权
-   - 授权范围：全部仓库/制品库
-   - 到期时间：按需选择，建议最小化
-   - 创建地址：https://cnb.cool/-/profile/tokens
-
-请提供以上信息。
-
-**用户**：CODING Token 是 xxx，CNB 组织名是 myteam，CNB Token 是 yyy
-
-**AI**：请确认以下迁移配置：
-- 源平台：CODING
-- 迁移范围：全部仓库
-- CNB 目标组织：myteam
-
-确认无误后我将开始迁移。
-
-**用户**：确认
-
-**AI**：（执行迁移脚本）
-
-### 示例 2：从 CODING 迁移指定项目
-
-**用户**：我只想迁移 CODING 上 backend 和 frontend 两个项目的仓库到 CNB
-
-**AI**：好的，只迁移指定项目。请提供：
-1. CODING Token — 源平台（创建地址：https://e.coding.net/user/tokens/create）
-2. CNB 目标组织名
-3. CNB Token — 目标平台，用于推送仓库（创建地址：https://cnb.cool/-/profile/tokens）
-
-**用户**：Token 都准备好了，CODING Token: xxx，CNB 组织: myteam，CNB Token: yyy
-
-**AI**：请确认以下迁移配置：
-- 源平台：CODING
-- 迁移范围：指定项目 → backend, frontend
-- CNB 目标组织：myteam
-
-确认无误后我将开始迁移。
-
-**用户**：没问题，开始吧
-
-**AI**：（执行迁移脚本，使用 `--migrate-type project --source-project "backend,frontend"`）
-
-### 示例 3：从 CODING 迁移指定仓库
-
-**用户**：帮我把 CODING 上 backend 项目里的 api-server 和 auth-service 两个仓库迁移到 CNB
-
-**AI**：好的，迁移指定仓库。请提供 CODING Token（源平台）、CNB 目标组织名和 CNB Token（目标平台，用于推送仓库）。
-
-**用户**：CODING Token: xxx，CNB 组织: myteam，CNB Token: yyy
-
-**AI**：请确认以下迁移配置：
-- 源平台：CODING
-- 迁移范围：指定仓库 → backend/api-server, backend/auth-service
-- CNB 目标组织：myteam
-
-确认后开始迁移。
-
-**用户**：确认
-
-**AI**：（执行迁移脚本，使用 `--source-repo "backend/api-server,backend/auth-service"`）
-
-### 示例 4：从 GitHub 迁移
-
-**用户**：我想从 GitHub 迁移几个仓库到 CNB
-
-**AI**：好的！从 GitHub 迁移仓库需要：
-
-1. **GitHub Token**（源平台，classic token）
-   - 权限要求：`repo:all`、`read:org`
-   - 创建地址：https://github.com/settings/tokens/new
-
-2. **CNB 目标组织名称**
-
-3. **CNB Token**（目标平台，用于推送仓库到 CNB）
-   - 权限要求：勾选「常见场景 - 迁移工具凭据」即可快速完成授权
-   - 创建地址：https://cnb.cool/-/profile/tokens
-
-另外请告诉我要迁移的仓库，格式为 `owner/repo`，多个用逗号分隔。
-
-**用户**：GitHub Token: ghp_xxx，CNB 组织: myteam，CNB Token: yyy，仓库: myuser/project-a,myuser/project-b
-
-**AI**：请确认以下迁移配置：
-- 源平台：GitHub
-- 迁移仓库：myuser/project-a, myuser/project-b
-- CNB 目标组织：myteam
-
-确认后开始迁移。
-
-**用户**：确认
-
-**AI**：（执行迁移脚本）
-
-### 示例 5：从华为云迁移
-
-**用户**：把华为云 CodeArts 上的仓库迁移到 CNB
-
-**AI**：华为云迁移需要额外的 AK/SK 认证。请提供：
-
-1. **华为云 Token**（源平台，HTTPS 密码，通过 CodeArts 控制台创建）
-2. **华为云 AK** 和 **SK**
-3. **区域**（默认 cn-north-4，如不同请告知）
-4. **CNB 目标组织名** 和 **CNB Token**（目标平台，用于推送仓库，创建地址：https://cnb.cool/-/profile/tokens）
-
-**用户**：Token: xxx，AK: ak123，SK: sk456，区域默认就行，CNB 组织: myteam，CNB Token: yyy
-
-**AI**：请确认以下迁移配置：
-- 源平台：华为云 CodeArts
-- 区域：cn-north-4
-- 迁移范围：全部仓库
-- CNB 目标组织：myteam
-
-确认后开始迁移。
-
-**用户**：确认
-
-**AI**：（执行迁移脚本，使用 `--source-ak ak123 --source-sk sk456 --source-region cn-north-4`）
-
-## 注意事项
-
-### ⚠️ 危险选项（需二次确认）
-
-以下选项开启时会暂停并提示确认，需输入 `yes` 才能继续：
-
-1. **`--force-push true`** - 强制推送
-   - 风险：强制覆盖 CNB 侧仓库历史，无法恢复
-   - 适用场景：CNB 侧仓库已损坏或需要完全替换
-
-2. **`--rebase true`** - Rebase 模式
-   - 风险：如遇冲突需人工解决，可能丢失提交
-   - 适用场景：需要保留 CNB 侧的流水线配置等修改
-
-3. **`--allow-incomplete-push true`** - 不完整推送
-   - 风险：可能忽略损坏的 LFS 文件，导致数据不完整
-   - 适用场景：源仓库 LFS 文件确实已损坏，需要忽略错误继续迁移
-
-### 一般注意事项
-
-1. **迁移前准备**：
-   - 确保 CNB 根组织已创建
-   - 确保 Token 权限足够
-   - 建议先在测试仓库验证
-
-2. **迁移中**：
-   - 确保只在一侧平台提交代码（避免冲突）
-   - 大仓库迁移时间较长，保持网络稳定
-   - LFS 文件会自动重试 3 次
-
-3. **迁移后**：
-   - 检查迁移日志确认成功
-   - 使用 `git lfs fsck` 验证 LFS 文件完整性
-   - 清空 `successful.log` 可重新增量同步
-
-## 常见问题
-
-**Q: 超过 256MB 大文件怎么处理？**
-A: 默认开启 `lfs_migrate=true`，会自动转 LFS。迁移后 commit ID 会变化。
-
-**Q: 获取仓库列表失败？**
-A: 检查 Token 权限，CODING 需要团队所有者或管理员权限。
-
-**Q: LFS 文件下载失败？**
-A: 先不开启 `allow_incomplete_push`，系统会自动重试。如确认源文件损坏再开启。
-
-**Q: push 失败提示先 pull？**
-A: 开启 `force_push=true` 强制覆盖（⚠️ 会覆盖 CNB 侧现有内容）。
-
-**Q: 只迁移部分仓库？**
-A: 开启 `allow_select_repos=true`，首次运行生成 `repo-path.txt`，编辑后再次运行。
-
-## 参考资料
-
-- [详细参数文档](https://cnb.cool/cnb/plugins/cnbcool/code-import/doc/parameters.md)
-- [Docker 使用指南](https://cnb.cool/cnb/plugins/cnbcool/code-import/doc/docker-usage.md)
-- [迁移工具源码](https://cnb.cool/cnb/plugins/cnbcool/code-import)