Windows 11 上配置VSCode 使用 Git 和 SSH 完整步骤
在 Windows 11 上,通过 VSCode 使用 Git 和 SSH 克隆 GitHub 仓库的完整优化步骤如下:
1. 安装必备工具
-
下载并安装 Git:
- 访问 Git 官网 下载最新版本。
- 安装时,选择以下选项:
- Default editor for Git: Use Visual Studio Code as Git’s default editor。
- Adjust your PATH environment: Git from the command line and also from 3rd-party software。
- Configuring the line ending conversions: Checkout Windows-style, commit Unix-style line endings。
-
下载并安装 VSCode:
- 访问 VSCode 官网 下载并安装。
-
检查 OpenSSH 是否启用:
- 打开
控制面板 > 程序 > 程序和功能 > 启用或关闭 Windows 功能
,确保 OpenSSH 客户端 已启用。
- 打开
2. 配置 Git 和 SSH
-
设置 Git 的用户信息:
打开命令提示符 (CMD) 或 PowerShell,输入以下命令:git config --global user.name "Your Name" git config --global user.email "your_email@example.com"
检查配置是否成功:
git config --global -l
-
生成 SSH 密钥:
- 打开终端(PowerShell 或 CMD):
如果不支持ssh-keygen -t ed25519 -C "your_email@example.com"
ed25519
,使用以下命令生成rsa
密钥:ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
- 当提示保存路径时,按回车键保存到默认路径:
C:\Users\YourUserName\.ssh\id_ed25519
- 设置一个密码(建议安全性更高)。
- 打开终端(PowerShell 或 CMD):
-
启动 SSH 代理并添加密钥:
打开终端,输入以下命令:eval "$(ssh-agent -s)" ssh-add C:\Users\YourUserName\.ssh\id_ed25519
-
将 SSH 公钥添加到 GitHub:
- 复制公钥:
type C:\Users\YourUserName\.ssh\id_ed25519.pub
- 登录 GitHub:
- 点击右上角头像 > Settings > SSH and GPG keys > New SSH key。
- 粘贴公钥内容,点击 Add SSH key。
- 复制公钥:
-
测试 SSH 连接:
在终端中输入:ssh -T git@github.com
如果成功,返回:
Hi username! You've successfully authenticated, but GitHub does not provide shell access.
3. 在 VSCode 中克隆 GitHub 仓库
-
获取 SSH URL:
- 登录 GitHub,导航到目标仓库。
- 点击绿色的 Code 按钮,选择 SSH,复制 URL(形如
git@github.com:username/repo.git
)。
-
在 VSCode 中克隆:
- 打开 VSCode。
- 按下
Ctrl+Shift+P
(或Cmd+Shift+P
),搜索并选择 Git: Clone。 - 在输入框中粘贴仓库的 SSH URL。
- 选择存储克隆文件的本地文件夹。
-
打开项目:
- 克隆完成后,VSCode 会提示是否打开该项目。
- 点击 Open,加载项目。
4. 提交和推送代码到 GitHub
-
在 VSCode 中修改代码:
修改文件后,VSCode 的 Source Control 面板会显示变更。 -
提交更改:
- 在终端中运行以下命令:
git add . git commit -m "Your commit message" git push
- 或在 Source Control 面板中点击
+
添加所有更改,填写提交信息后点击 ✔️ Commit。
- 在终端中运行以下命令:
-
推送到 GitHub:
在终端运行:git push
或点击 Source Control 面板中的 Push 按钮。
5. 配置多账号或多个 SSH 密钥(可选)
如果需要配置多个 SSH 密钥(如公司和个人 GitHub 账号),需设置 ~/.ssh/config
文件:
- 编辑
C:\Users\YourUserName\.ssh\config
文件(如果不存在,创建一个)。 - 添加以下内容:
Host github-personal HostName github.com User git IdentityFile C:\Users\YourUserName\.ssh\id_ed25519_personal Host github-work HostName github.com User git IdentityFile C:\Users\YourUserName\.ssh\id_ed25519_work
- 使用指定配置克隆仓库:
git clone git@github-personal:username/repo.git
6. 常见问题及解决方法
-
SSH 连接失败:
- 检查
~/.ssh
文件夹权限,确保仅当前用户有访问权限。 - 验证 GitHub 公钥是否正确添加。
- 检查
-
VSCode 无法识别 Git:
- 确保 Git 已正确安装。
- 在 VSCode 中按
Ctrl+Shift+P
,搜索并打开 Settings。 - 搜索
Git Path
,手动设置为C:\Program Files\Git\bin\git.exe
。
-
权限问题:
- 如果出现
Permission denied
,尝试重新添加密钥或切换到正确的配置。
- 如果出现