Help us learn about your current experience with the documentation. Take the survey.

Web IDE

  • 版本：免费版、高级版、旗舰版
  • 提供方式：GitLab.com、GitLab 自托管、GitLab 专用

Web IDE 是一个高级编辑器，您可以在 GitLab UI 中直接编辑多个文件、暂存更改并创建提交。与 Web Editor 不同，Web IDE 提供了一个具有源代码管理功能的完整开发环境。

Web IDE 对 GitLab Flavored Markdown 预览的支持已在 epic 15810 中提出。

打开 Web IDE

您可以通过几种方式访问 Web IDE。

使用键盘快捷键

  1. 在左侧边栏，选择 搜索或跳转 并找到您的项目。
  2. 使用 . 键盘快捷键。

从目录打开

  1. 在左侧边栏，选择 搜索或跳转 并找到您的项目。
  2. 进入您的目录。
  3. 选择 代码 > 在 Web IDE 中打开。

从文件打开

  1. 在左侧边栏，选择 搜索或跳转 并找到您的项目。
  2. 进入您的文件。
  3. 选择 编辑 > 在 Web IDE 中打开。

从合并请求打开

  1. 在左侧边栏，选择 搜索或跳转 并找到您的项目。
  2. 进入您的合并请求。
  3. 在右上角，选择 代码 > 在 Web IDE 中打开。

Web IDE 在单独的标签页中打开新文件和修改过的文件，并并排显示更改。为减少加载时间，只有修改行数最多的 10 个文件会自动打开。

Web IDE 界面在左侧边栏 资源管理器 视图中，新文件或修改过的文件旁边显示合并请求图标（ merge-request ）。要查看文件的更改，右键单击该文件并选择 与合并请求基础版本比较。

管理文件

您可以使用 Web IDE 打开、编辑和上传多个文件。

打开文件

要在 Web IDE 中按名称打开文件：

  1. 按 Command+P。
  2. 在搜索框中输入文件名。

搜索打开的文件

要在 Web IDE 中搜索打开的文件：

  1. 按 Shift+Command+F。
  2. 在搜索框中输入您的搜索词。

上传文件

要在 Web IDE 中上传文件：

  1. 在 Web IDE 左侧，选择 资源管理器（ documents ），或 按 Shift+Command+E。

  2. 进入要上传文件的目录。 要创建新目录：

    • 在 资源管理器 视图中，右上角， 选择 新建文件夹（ folder-new ）。

  3. 右键单击目录并选择 上传。

  4. 选择您要上传的文件。

您可以一次上传多个文件。 文件会被上传并自动添加到仓库中。

恢复未提交的更改

您无需手动保存在 Web IDE 中编辑的任何文件。 Web IDE 会暂存您修改的文件，因此您可以 提交更改。 未提交的更改会保存在您浏览器的本地存储中。即使您关闭浏览器标签页或刷新 Web IDE，这些更改也会保留。

如果您的未提交更改不可用，您可以从本地历史记录中恢复更改。 要在 Web IDE 中恢复未提交的更改：

  1. 按 Shift+Command+P。
  2. 在搜索框中输入 Local History: Find Entry to Restore。
  3. 选择包含未提交更改的文件。

使用源代码控制

您可以使用源代码控制来查看修改过的文件、创建和切换分支、提交更改以及创建合并请求。

查看修改过的文件

要在 Web IDE 中查看您修改过的文件列表：

  • 在 Web IDE 左侧，选择 源代码控制（ branch ），或 按 Control+Shift+G。

您的 更改、已暂存更改 和 合并更改 会显示出来。 有关更多信息，请参阅 VS Code 文档。

切换分支

Web IDE 默认使用当前分支。 要在 Web IDE 中切换分支：

  1. 在底部状态栏左侧，选择当前分支名称。
  2. 输入或选择现有分支。

创建分支

要在 Web IDE 中从当前分支创建分支：

  1. 在底部状态栏左侧，选择当前分支名称。
  2. 从下拉列表中，选择 创建新分支。
  3. 输入新分支名称。

如果您对仓库没有写入权限，创建新分支 不可见。

提交更改

要在 Web IDE 中提交更改：

  1. 在 Web IDE 左侧，选择 源代码控制（ branch ），或 按 Control+Shift+G。
  2. 输入您的提交消息。
  3. 选择以下提交选项之一：

提交并强制推送

要提交并强制推送您的更改：

  1. 选择操作按钮菜单或选择省略号（ ellipsis_h ）。
  2. 选择 提交并强制推送。

此操作会覆盖当前分支的远程历史记录。请谨慎使用。

修改提交并强制推送

要修改最后一次提交并强制推送：

  1. 选择操作按钮菜单或选择省略号（ ellipsis_h ）。
  2. 选择 修改提交并强制推送。

这会更新最后一次提交并将其强制推送到远程仓库。使用此功能可以修复最近的提交，而无需创建新的提交。

创建合并请求

要在 Web IDE 中创建 合并请求：

  1. 提交更改。
  2. 在右下角出现的通知中，选择 创建合并请求。

有关更多信息，请参阅 查看错过的通知。

自定义 Web IDE

自定义 Web IDE 以匹配您对键盘快捷键、主题、设置和同步的偏好。

使用命令面板

您可以使用命令面板访问许多命令。 要在 Web IDE 中打开命令面板并运行命令：

  1. 按 Shift+Command+P。
  2. 输入或选择命令。

编辑设置

您可以使用设置编辑器来查看和编辑您的用户和工作区设置。 要在 Web IDE 中打开设置编辑器：

  • 在顶部菜单栏，选择 文件 > 首选项 > 设置， 或按 Command+,。

在设置编辑器中，您可以搜索要更改的设置。

编辑键盘快捷键

您可以使用键盘快捷键编辑器来查看和更改 所有可用命令的默认键绑定。 要在 Web IDE 中打开键盘快捷键编辑器：

  • 在顶部菜单栏，选择 文件 > 首选项 > 键盘快捷键， 或按 Command+K 然后 Command+S。

在键盘快捷键编辑器中，您可以搜索：

  • 您要更改的键绑定
  • 您要添加或删除键绑定的命令

键绑定基于您的键盘布局。 如果您更改键盘布局，现有的键绑定会自动更新。

更改颜色主题

您可以为 Web IDE 选择不同的颜色主题。 默认主题是 GitLab 暗色。

要在 Web IDE 中更改颜色主题：

  1. 在顶部菜单栏，选择 文件 > 首选项 > 主题 > 颜色主题， 或按 Command+K 然后 Command+T。
  2. 从下拉列表中，使用箭头键预览主题。
  3. 选择一个主题。

Web IDE 会将您的活动颜色主题存储在您的 用户设置 中。

配置同步设置

要在 Web IDE 中配置同步设置：

  1. 按 Shift+Command+P。
  2. 在搜索框中输入 Settings Sync: Configure。
  3. 选择或清除以下复选框：
    • 设置
    • 键盘快捷键
    • 用户代码片段
    • 用户任务
    • UI 状态
    • 扩展
    • 配置文件

这些设置会在多个 Web IDE 实例之间自动同步。 您无法同步用户配置文件或恢复到同步设置的早期版本。

查看错过的通知

当您在 Web IDE 中执行操作时，通知会出现在右下角。 要查看您可能错过的任何通知：

  1. 在底部状态栏右侧，选择通知铃铛图标（ notifications ） 以查看通知列表。
  2. 选择您要查看的通知。

管理扩展

  • 提供方式：GitLab.com、GitLab 自托管

VS Code 扩展市场为您提供访问增强 Web IDE 功能的扩展。默认情况下，GitLab Web IDE 实例配置为使用 Open VSX 注册表。

要访问 VS Code 扩展市场，您的网络浏览器必须能够访问 .cdn.web-ide.gitlab-static.net 资产主机。此安全要求确保第三方扩展在隔离环境中运行，无法访问您的账户。

在您可以在 Web IDE 中管理和使用扩展之前：

安装扩展

要在 Web IDE 中安装扩展：

  1. 在顶部菜单栏，选择 视图 > 扩展， 或按 Command+Shift+X。
  2. 在搜索框中输入扩展名称。
  3. 选择您要安装的扩展。
  4. 选择 安装。

卸载扩展

要在 Web IDE 中卸载扩展：

  1. 在顶部菜单栏，选择 视图 > 扩展， 或按 Command+Shift+X。
  2. 从已安装扩展列表中，选择您要卸载的扩展。
  3. 选择 卸载。

扩展设置

Web IDE 扩展可能需要额外的配置才能与您的项目一起工作。

使用 Vim 键绑定

使用 Vim 键绑定来使用 Vim 文本编辑器的键盘快捷键导航和编辑文本。 通过扩展市场，您可以为 Web IDE 添加 Vim 键绑定。

要启用 Vim 键绑定，请安装 Vim 扩展。有关更多信息，请参阅 安装扩展。

AsciiDoc 支持

AsciiDoc 扩展为 Web IDE 中的 AsciiDoc 文件提供实时预览、语法高亮和代码片段。要在 Web IDE 中使用 AsciiDoc 标记预览，您必须安装 AsciiDoc 扩展。有关更多信息，请参阅 安装扩展。

相关主题

故障排除

在使用 Web IDE 时，您可能会遇到以下问题。

输入时的字符偏移

在 Web IDE 中输入时，您可能会遇到四个字符的偏移。 作为临时解决方案：

  1. 在顶部菜单栏，选择 文件 > 首选项 > 设置， 或按 Command+,。
  2. 在右上角，选择 打开设置 (JSON)。
  3. 在 settings.json 文件中，添加 "editor.disableMonospaceOptimizations": true 或更改 "editor.fontFamily" 设置。

有关更多信息，请参阅 VS Code 问题 80170。

更新 OAuth 回调 URL

  • 提供方式：GitLab 自托管

先决条件：

  • 您必须拥有实例的管理员权限。

Web IDE 使用 实例范围的 OAuth 应用程序 进行身份验证。 如果 OAuth 回调 URL 配置错误，您可能会遇到 无法打开 Web IDE 错误页面，显示以下消息：

您用于访问 Web IDE 的 URL 与配置的 OAuth 回调 URL 不匹配。此问题通常在使用代理时发生。

要解决此问题，您必须更新 OAuth 回调 URL 以匹配用于访问 GitLab 实例的 URL。

要更新 OAuth 回调 URL：

  1. 在左侧边栏底部，选择 管理。
  2. 选择 应用程序。
  3. 对于 GitLab Web IDE，选择 编辑。
  4. 输入 OAuth 回调 URL。 您可以输入多个以换行符分隔的 URL。

访问令牌生命周期不能少于 5 分钟

  • 提供方式：GitLab 自托管

您可能会遇到一条错误消息，指出访问令牌生命周期不能少于 5 分钟。

当您的 GitLab 实例配置的访问令牌过期时间少于 5 分钟时，会发生此错误。Web IDE 需要生命周期至少为 5 分钟的访问令牌才能正常运行。

要解决此问题，请在您的实例配置中将访问令牌生命周期增加到至少 5 分钟。有关配置访问令牌过期的更多信息，请参阅 访问令牌过期。

Workhorse 依赖

  • 提供方式：GitLab 自托管

在 GitLab 自托管中，Workhorse 必须安装在 GitLab Rails 服务器前面并运行。如果没有，您在打开 Web IDE 或使用 Markdown 预览等某些功能时可能会遇到问题。

出于安全考虑，Web IDE 的某些部分必须在单独的源中运行。为了支持这种方法，Web IDE 使用 Workhorse 来适当地路由到 Web IDE 资产和从 Web IDE 资产发出的请求。Web IDE 资产是静态前端资产，因此依赖 Rails 来完成这项工作是不必要的开销。

报告问题

要报告问题，创建新问题 并提供以下信息：

  • 错误消息
  • 完整的错误详情
  • 问题发生的频率
  • 复制问题的步骤

如果您使用的是付费版本，也可以 联系支持团队 获取帮助。