RuYi Workstation 使用指南
RuYi Workstation 是面向开发者的桌面工作站，帮助你把本地项目、开发工具、服务器资源、部署流程和生产版本放在同一条工作流中管理。你仍然可以使用熟悉的 IDE、终端和代码助手；Workstation 负责组织项目上下文、连接资源、准备部署并跟踪发布结果。
Workstation 是开发控制台，RuYi Panel 提供服务器侧的运行时能力。服务器管理和部署操作通过受支持的 RuYi 运行时接口执行。
一、认识主界面
左侧主导航包含以下页面：
| 页面 | 用途 |
|---|---|
| 工作台 | 查看近期项目、部署和资源状态，并使用常用操作 |
| 项目 | 导入、查找和管理本机项目 |
| 部署 | 汇总查看部署任务和运行进度 |
| 资源 | 添加服务器并查看其连接和托管状态 |
| 工具 | 打开服务器终端、文件、远程桌面等工具，以及本机维护工具 |
| 设置 | 管理开发工具、RuYi Controller、外观、部署和 AI 模型等设置 |
顶部搜索框可用 Ctrl+K 打开，用于快速查找 Workstation 中的项目、部署和资源。侧边栏顶部的按钮可展开或收起导航；右上角可切换主题。
左下角的 RuYi Controller 状态卡显示本机工作流服务的连接状态。若显示未连接，可进入 设置 → RuYi Controller 查看状态和原因，再尝试重新连接。部署或项目管理相关操作无法使用时，先确认该状态正常。
二、开始前的准备
- 启动 RuYi Workstation，确认主界面左下角的 RuYi Controller 状态正常。
- 如果要打开本机 IDE 或开发助手，确认对应程序已安装。可在 设置 → 开发工具 查看检测结果、选择程序路径，并设置默认编辑器。
- 如果要部署到服务器，先在 资源 页面添加并连接服务器。部署向导只会列出满足托管和兼容条件的目标。
- 使用 Git 仓库时，确保本机 Git 和仓库访问凭据已配置好。
选择自定义开发工具路径后，Workstation 会验证所选程序；验证通过后才能用于项目工作区中的启动操作。各设置页面的变更请按页面提示保存。
三、添加项目
进入 项目 页面后，可以导入电脑上已有的项目目录，也可以从 Git 仓库克隆项目。
导入本地项目
- 选择 导入本地项目，浏览并选中项目目录。
- Workstation 会扫描目录并展示识别到的项目结构和技术栈。
- 检查扫描结果；如有需要，修正项目名称或技术栈后再确认导入。
导入只是把现有目录登记到 Workstation，不会复制、移动或修改项目源码。
从 Git 添加项目
- 选择从 Git 添加，填写仓库地址、保存位置，以及需要检出的分支（如有）。
- 开始克隆，等待克隆和项目扫描完成。
- 检查项目识别结果并确认添加。
私有仓库请使用本机已经配置的 Git 凭据或 SSH Agent。克隆成功后仍需确认项目扫描结果，项目才会出现在 Workstation 的项目列表中。
四、使用项目工作区
打开项目后，项目页顶部会显示项目名称、路径、技术栈和 Git 分支等信息。Git 分支用于确认当前登记目录对应的检出分支，方便在开发或发布前核对代码上下文；它是状态信息，不是分支切换器，也不能单独证明服务器上运行的版本来自该分支。
项目工作区分为四个部分：
- 总览：查看项目识别信息和常用操作。
- 开发：打开项目目录、IDE、终端或已检测到的开发助手；查看开发环境和 Git 工作区信息。
- 部署：管理部署流水线、环境与目标，并查看部署历史。
- 生产：查看生产概况和已登记的发布版本。
在 开发 页中，如果工具未检测到，可前往 设置 → 开发工具 重新检测，或手动选择可执行文件并完成验证。启动 IDE 或命令行工具时，Workstation 会把当前项目路径传给外部程序。外部工具的账号登录和会话仍由该工具本身管理。
五、添加服务器资源
进入 资源 页面，选择添加服务器。根据服务器现状选择接入方式：
连接已安装 RuYi Panel 的服务器
填写服务器名称、Panel 地址和对应的 OpenAPI Key，先测试连接；测试通过后再添加资源。请妥善保管 API Key，不要把密钥、密码或私钥放进公开文档和截图。
接入新服务器
填写服务器基本信息后，可以按界面引导通过 SSH 接入 Linux 服务器，并选择是否立即安装或初始化 RuYi Panel。若暂不安装，也可以先登记为未托管资源；此时它不一定能作为部署目标。Windows 服务器可登记为资源，但当前界面不提供自动安装流程。
添加后，可在资源列表查看在线状态、托管状态和资源详情。需要部署时，先确认服务器连接正常，并且已经完成所需的托管和运行环境准备。
六、创建部署并查看进度
从项目开始部署
打开项目，在项目页头部选择 开始部署。首次从导入流程进入时，Workstation 也可能直接打开上线向导。按向导逐步完成：
- 选择：确认项目组件和发布范围，选择适合项目技术栈的部署模板，并检查构建或发布选项。不同模板会显示不同配置项。
- 准备：查看预检清单，选择环境和已托管的服务器目标，并确认部署策略。若没有可选目标，先到 资源 页面接入并托管服务器。
- 确认：检查部署计划、目标和验证提示。若页面显示阻止项，先处理后再启动；警告项也应在继续前确认其影响。
- 进度：启动后查看运行状态、步骤进度和日志。完成后可继续打开部署详情或部署流水线。
首次部署成功后，可以在向导结果中查看应用状态和可访问信息（具体内容取决于部署模板及目标环境）。后续可从 部署 → 部署历史 或项目的部署历史中重新打开任务详情。
查看和编辑部署流水线
在项目的 部署 → 流水线 中，可根据项目技术栈创建流水线、打开设计器并检查任务节点。首次上线向导会创建或使用相应的流水线；需要调整构建、发布步骤时，可回到流水线设计器检查并保存配置。
环境与目标用于查看项目关联的环境、服务器组和发布目标；部署历史记录每次运行的状态和详情。生产环境和目标的配置请在启动发布前确认。
七、查看生产版本
在项目的 生产 页面查看当前生产概况和运行状态；切换到发布版本可查看登记的版本、关联提交信息及其部署使用情况。版本信息用于追踪发布记录。若发布状态异常，先打开对应部署详情核对运行步骤和日志。
八、工具和设置
工具
工具页面集中放置服务器终端、文件管理和远程桌面入口，以及 HeidiSQL、磁盘空间优化、内存优化等本机工具。服务器类工具需要先选定可用资源；部分本机维护工具只在受支持的平台显示。
设置
- 常规与外观：设置启动行为、语言、主题和界面密度等偏好。
- 开发工具：检查已安装的 IDE、命令行助手和工具链，设置默认编辑器或手动选择程序路径。
- RuYi Controller：查看本机 Controller 连接状态，执行重新连接，并调整相关运行设置。
- 部署：配置部署相关的默认选项。
- AI 模型：配置 AI 服务提供方、模型和能力。该设置用于 Workstation 中已有的 AI 辅助能力，不代表 Workstation 提供独立的图片或视频创作流程。
九、常见问题
本文按 RuYi Workstation 当前界面编写。不同版本、平台和部署模板的可用选项可能不同；请以客户端实际显示为准。