logo
0
0
WeChat Login
docs: 更新README以添加脚本更新流程说明

CNB Workspace SSH to Trae Helper

这是一个为 CNB (Cloud Native Build) 平台开发的效率工具。它可以自动检测工作空间 SSH 连接弹窗,并生成一个"在 Trae 中打开"的按钮,让您可以一键启动 Trae IDE 进行远程开发。

✨ 特性

  • 一键连接: 自动提取 SSH 连接信息,生成协议链接,一键唤起开发环境。
  • 双模式支持: 同时支持 Trae IDE 和 MobaXterm 两种连接方式,满足不同使用场景。
  • 智能防重: 智能检测按钮状态,防止重复添加,同时支持组件复用场景下的链接更新。
  • 自动更新: 集成自动更新机制,脚本升级后浏览器端自动提示更新。
  • 极客设计: 采用 Trae 黑绿配色和 MobaXterm 蓝色渐变配色,完美融入开发环境。

🚀 安装指南

  1. 安装油猴插件: 确保您的浏览器已安装 Tampermonkey 扩展。
  2. 安装脚本: 访问 官方主页 点击"安装脚本"按钮。
  3. 开始使用:
    • 打开 CNB 工作空间。
    • 点击"SSH 连接"。
    • 在弹窗中点击 "在 Trae 中打开" (黑色) 或 "在 MobaXterm 中打开" (蓝色) 按钮。

MobaXterm 配置 (可选)

如需使用 MobaXterm 连接,请先配置协议支持:

  1. 下载配置工具: MobaRemoteTool.bat
  2. 安装协议: 右键运行,选择 [1] Install 安装
  3. 测试: 选择 [3] Test Protocol 测试连接

详细配置说明请查看 文档页面 的 FAQ 部分。

🛠️ 开发与构建

本项目包含脚本源代码和一个用于介绍的静态网站。

目录结构

  • 云原生开发TRAE打开远程的按钮.js: 油猴脚本源代码。
  • src/: 静态网站源码 (EJS + CSS)。
  • data/: 网站内容数据 (JSON)。
  • scripts/: 构建脚本。

本地开发

需要 Node.js v20+ 环境。

# 初始化环境 (如果在 CNB 且未安装 Node) ./.ide/init.sh # 安装依赖 npm install # 构建项目 npm run build # 本地预览 (生成的网站在 dist/ 目录) npx http-server dist

如何添加新脚本

如果您想在这个项目中托管新的油猴脚本,请按照以下步骤操作:

  1. 添加脚本文件: 将您的 .js 脚本文件放置在项目根目录下(例如 my-new-script.user.js)。

  2. 更新配置数据: 编辑 data/scripts.json 文件,在数组中添加新脚本的元数据:

    { "id": "my-new-script", "name": "脚本名称", "version": "1.0.0", "description": "脚本的一句话简介", "downloadUrl": "https://mkscript.zhenxijs.com/my-new-script.user.js", "imageUrl": "/assets/images/preview-new.png", // 可选:预览图 "features": [ "特性 1", "特性 2" ], "usage": [ "第一步操作...", "第二步操作..." ], "faq": [] // 可选:常见问题 }
  3. 配置构建流程: 编辑 scripts/build.js,在 build 函数中添加新脚本的复制逻辑:

    // 在 fs.copy 附近添加 await fs.copy( path.join(__dirname, '../my-new-script.user.js'), path.join(config.distDir, 'my-new-script.user.js') );
  4. 提交并发布

    git add . git commit -m "feat: 添加新脚本 xxx" git push

    CI 流水线会在提交标签的时候自动构建并更新网站。

🔄 更新流程

当需要更新现有脚本时,请按照以下步骤操作:

  1. 更新脚本代码:

    • 修改根目录下的脚本文件 (例如 云原生开发TRAE打开远程的按钮.js)。
    • 务必更新脚本头部注释中的 @version 字段。
  2. 更新网站元数据:

    • 编辑 data/scripts.json 文件。
    • 找到对应的脚本条目,更新 "version" 字段以匹配脚本的新版本。
  3. 编写更新日志:

    • 编辑 data/changelog.json 文件。
    • 在数组顶部添加一个新的对象,包含 version (网站版本), date, 和 changes
    • 示例:
      { "version": "0.0.5", "date": "2026-02-07", "changes": [ "脚本更新:发布 v0.0.2 版本", "新增:功能 A" ] }
  4. 提交更改:

    • 提交代码后,CNB 流水线会自动构建并发布更新到网站。

部署

本项目配置了 CNB 流水线 (.cnb.yml),代码推送标签到仓库后会自动构建并部署到 EdgeOne Pages。

  • 自动构建: 生成静态 HTML 和 .user.js 文件。
  • 自动发布: 部署到 https://mkscript.zhenxijs.com/

📝 版本历史

查看 Changelog 了解详细更新记录。

📄 License

ISC