WSLGit 使用手册

安装指南

WSLGit 是一个便捷工具，让 Windows 上的 Visual Studio Code 能无缝地使用 Windows 子系统 for Linux（WSL）中的 Git。以下是安装步骤：

下载最新版本

从 GitHub 发布页面下载最新的二进制文件。

可选安装步骤

步骤 1: 管理员权限运行 install.bat

此脚本会在类似于“Git For Windows”的结构下创建文件夹，并在 wslgit\cmd 和 wslgit\bin 中创建有用的符号链接。

步骤 2: 添加到环境变量

手动将 wslgit\cmd 目录添加到您的 Windows Path 环境变量中，以便全局访问 wslgit 命令。

额外依赖

确保已安装 Microsoft Visual C++ Redistributable for Visual Studio 2017，以支持必要的库文件。

项目使用说明

在 Visual Studio Code 中使用

1. 如果已经完成了上述任一步可选安装，则 VSCode 应自动找到 git。
2. 否则，您需要在设置里手动指定路径：

   {
       "git.path": "C:\\更换为\\实际\\wslgit路径\\wslgit.exe"
   }
   

3. 确保用于 Git 的 SSH 密钥无密码，或SSH代理已在WSL内启动并包含了相应的密钥。

命令行使用

完成安装后，在命令提示符中，直接输入 wslgit 加上任何 Git 命令，即可调用 WSL 内的 Git 版本。

API 使用文档

WSLGit本身不提供传统意义上的API接口，而是作为命令行工具桥接Windows与WSL下的Git交互。但可以视为有以下“API”行为：

• 转换路径：自动处理Windows与Linux文件系统路径间的转换。
• 环境感知：通过环境变量如 WSLGIT_DEFAULT_DIST 来选择默认的WSL发行版。
• 交互模式控制：通过 WSLGIT_USE_INTERACTIVE_SHELL 控制特定Git操作时是否启动交互式shell。

项目构建方式

若需从源代码编译WSLGit，首先安装 Rust 和 Visual Studio的相关工具。随后，在项目根目录执行以下命令来构建最终的可执行文件：

cargo build --release

测试时，请使用单线程以防环境变量变更导致的竞争条件错误：

cargo test -- --test-threads=1

如此一来，您将拥有一个适应于WSL环境的Git操作利器，完美集成于Windows开发环境中。