WebStorm 2025.2 Help

设置 Git 仓库

当您 克隆一个已有的 Git 仓库或 将现有项目置于 Git 版本控制下时，WebStorm 会自动检测您的计算机上是否安装了 Git。 如果 IDE 无法定位 Git 可执行文件，它会建议下载该文件。

WebStorm 支持来自 适用于 Linux 的 Windows 子系统 2（WSL2） 的 Git，该功能在 Windows 10 版本 2004 中可用。

如果 Windows 上未安装 Git，WebStorm 会在 WSL 中查找并从中使用 Git。 另外，当您使用 \\wsl$ 路径打开项目时，WebStorm 会自动切换为使用来自 WSL 的 Git。

如果需要手动配置 WebStorm 使用来自 WSL 的 Git，请前往 版本控制 | Git 设置页面 Ctrl+Alt+S ，在 Git 可执行文件路径 字段中点击 浏览 图标，并通过 \wsl$ 路径选择来自 WSL 的 Git，例如： \\wsl$\debian\usr\bin\git。

从远程主机检出项目（git clone）

WebStorm 允许您检出（在 Git 术语中即 克隆 ）一个已有仓库，并基于已下载的数据创建新项目。

  1. 要开始克隆 Git 仓库，请执行以下任一操作：

    • 如果版本控制集成已启用，请转到 Git | 克隆。

    • 如果尚未启用版本控制集成，请转到 VCS | 从版本控制获取。

      或者，转到 文件 | 新建 | 来自版本控制的项目。

    • 如果当前未打开任何项目，请在 欢迎 屏幕上点击 克隆仓库。

  2. 在 克隆存储库 对话框中，指定要克隆的远程仓库的 URL，或从左侧选择一个 VCS 托管服务。

    如果您已登录所选的托管服务，补全功能将建议可以克隆的仓库列表。

    如果希望执行 shallow clone 并限制历史记录，请勾选 浅克隆并将历史记录截断为 复选框并指定要克隆的提交数量。

    稍后可以通过主菜单中选择 Git | 取消浅克隆存储库 来获取其余历史记录。

  3. 点击 克隆。 如果希望基于克隆的源代码创建项目，请在确认对话框中点击 是。 Git 根映射将自动设置为项目根目录。

    如果项目中包含 子模块 ，它们也将被克隆并自动注册为项目根目录。

  4. 在 信任并打开项目 '<project_name>'？ 项目安全性对话框中，选择您希望打开项目的方式： 信任项目 或 在安全模式下预览。

将现有项目置于 Git 版本控制下

您可以基于现有的项目源代码创建本地 Git 仓库。

将整个 项目 关联到一个 Git 仓库

  1. 打开您希望置于 Git 下的 项目。

  2. 按下 Alt+` 打开 VCS 操作弹出窗口 ，然后选择 启用版本控制集成。

    或者，转到 VCS | 启用版本控制集成。

  3. 选择 Git 作为版本控制系统，然后点击 确定。

    整个项目将关联到一个 Git 目录，因此无需为每一个文件单独添加到 Git 目录中。

  4. 启用 VCS 集成后，WebStorm 会询问您是否希望通过 VCS 共享项目设置文件。 您可以选择 始终添加 将项目设置与使用 WebStorm 的其他仓库用户同步。

    提示选择如何处理配置文件的通知

将项目内的不同目录关联到不同的 Git 仓库

  1. 打开您希望置于 Git 下的目录。

  2. 在主菜单中，前往 VCS | 创建 Git 存储库。

  3. 在打开的对话框中，指定要创建新 Git 仓库的目录。

    Git 不支持外部路径，因此如果您选择的目录位于项目根目录之外，请确保仓库要创建的文件夹也包含项目根目录。

  4. 如果在 项目 结构中创建多个 Git 仓库，请针对每个目录重复上述步骤。

在为项目 初始化 Git 仓库 后，您需要将项目文件添加到该仓库中。

将文件添加到本地仓库

  1. 在 提交 工具窗口 Alt+0 中，展开 未版本管理文件 节点。

  2. 选择要添加到 Git 的文件或整个变更列表，然后按 Ctrl+Alt+A ，或从上下文菜单中选择 添加到 VCS。

    您也可以在 项目 工具窗口 Alt+1 中，将文件添加到本地 Git 仓库：选择要添加的文件，按 Ctrl+Alt+A ，或从上下文菜单中选择 Git | 添加。

当 Git 集成在您的 项目 中启用后，即使是从 WebStorm 外部添加的文件，WebStorm 也会建议将每个新建文件添加到 Git 中。 您可以在 版本控制 | 确认 设置页面 Ctrl+Alt+S 中更改该行为。 如果希望某些文件始终保持未版本控制状态，您可以 忽略它们。

从版本控制中排除文件（忽略）

有时，您可能需要让某些文件保持未纳入版本控制的状态。 这类文件可能包括 VCS 管理文件、实用程序生成的产物、备份副本等。 您可以通过 WebStorm 忽略文件，IDE 将不会建议将这些文件添加到 Git，并会将其高亮显示为已忽略。

您只能忽略 unversioned 文件，也就是在 未版本管理文件 更改列表中看到的文件。 如果某个文件已 added to Git 但尚未 committed ，您可以在 提交 窗口中右键点击该文件，并选择 回滚。

Git 允许您在两类配置文件中列出忽略文件的模式：

  • .git/info/exclude 文件。

    该文件中列出的模式仅适用于当前仓库的本地副本。

    初始化或检出 Git 仓库时将自动创建此文件。

  • VCS 根目录及其子目录中的一个或多个 .gitignore 文件。

    这些文件会被检入仓库，因此其中的忽略模式对整个团队可用。 因此，它是保存忽略文件模式最常见的位置。

    如果在 VCS 根目录中没有 .gitignore 文件，您可以在 项目 工具窗口中任意位置右键点击，选择 新建 | 文件 ，并在 新建文件 对话框中输入 .gitignore 。

将文件添加到 .gitignore 或 .git/info/exclude

  1. 决定将使用哪种 kind of Git configuration file 来忽略文件。 如果无法确定，请使用 .gitignore 。

  2. 在 提交 窗口或 项目 工具窗口 Alt+1 中找到您想忽略的未纳入版本控制的文件或文件夹。 这些视图中的文件颜色 有助于您识别文件的状态。

  3. 右键点击所选内容，然后选择 Git | 添加到 .gitignore 或 Git | 添加到 .git/info/exclude。

    这些视图中的文件颜色 有助于您识别文件的状态。

如果需要按照特定模式或类型排除文件，您可以直接编辑 .gitignore 或 .git/info/exclude 文件。 请参阅 .gitignore patterns format。

添加远程仓库

如果您是基于本地源 created a Git repository ，则需要添加远程仓库，以便能够协作处理 Git 项目，同时避免将整个代码库仅存储在本地的风险。 当您需要共享工作时，您可以将更改 push 到远程仓库，并从中 pull 数据，从而将其他贡献者所做的更改集成到您本地的仓库版本中。

如果您已 cloned a remote Git repository ，例如来自 GitHub ，则远程会自动配置，您在 sync 时无需指定。 Git 分配给您克隆来源远程仓库的默认名称是 origin。

定义远程

  1. 在任意 Git 托管平台（如 Bitbucket、 GitHub 或 GitLab ）上创建空仓库。 您可以直接在 WebStorm 中创建 GitHub 或 GitLab 仓库：请参阅 Share a project on GitHub 和 Share a project on GitLab。

  2. 准备好推送提交时，调用 推送 对话框，方法是从主菜单中选择 Git | 推送 ，或按下 Ctrl+Shift+K。

  3. 如果尚未添加任何远程， 定义远程 链接将会取代远程名称显示。 点击此链接以添加远程。

  4. 在打开的对话框中，指定远程名称和其托管的 URL。

    选择 提取远程 选项，以便立即 fetch 分支列表和提交历史。

添加第二个远程

在某些情况下，您还需要添加第二个远程仓库。 例如，如果您克隆了一个无法写入的仓库，并准备将更改推送到自己对原始项目的 fork 中时，这会很有用。 另一个常见场景是您克隆了自己的仓库，它是某个他人的项目 fork，您需要与原始项目同步并从其中拉取更改。

  1. 在主菜单中，转到 Git | 管理远程。 将打开 Git 远程 对话框。

  2. 点击工具栏上的 添加 添加 按钮，或按下 Alt+Insert。

  3. 在打开的对话框中，指定远程名称和 URL，然后点击 确定。

您可以通过以下视频了解更多信息：

为 Git 远程设置密码

每次与远程 Git 版本库交互时（例如执行 pull、 update或 push操作时），都需要进行授权。 您可以 配置 WebStorm 以记住您的密码 ，从而在每次需要授权时无需输入凭据。

配置密码策略

  1. 在 设置 对话框 Ctrl+Alt+S 中，在左侧选择 外观与行为 | 系统设置 | 密码。

  2. 选择 WebStorm 处理 Git 远程版本库密码的方式：

    • 在本地 Keychain 中 ：选择此选项以使用原生 Keychain 来存储您的密码。 此设置仅适用于 macOS 和 Linux。

    • 使用 KeePass ：选择此选项以使用 KeePass 密码管理器来存储您的密码。 使用 KeePass 密码管理器 时，将使用主密码来访问存储各个密码的文件。 一旦 WebStorm 记住了您的密码，除非需要访问密码数据库，否则不会再次请求输入。 在 主密码 字段中输入用于访问 c.kdbx 文件的密码。

      您可以在 数据库 字段中更改 c.kdbx 文件的默认位置。

      要导入 c.kdbx 文件，请点击 设置图标 并从下拉菜单中选择 导入 ，或点击 “浏览”按钮 并指定包含密码的本地文件路径。

      如果您希望从数据库中移除已有密码，请选择 清除。

    • 不保存，重启后忘记密码 ：如果您希望在关闭 WebStorm 后重置密码，请选择此选项。

最后修改日期： 2025年 9月 26日
教程：在 WebStorm 中开始使用 Git将文件添加到 Git 并跟踪更改