使用 SSH 连接进行 GitHub CLI (gh) 登录教程

GitHub CLI（简称 gh）是一个强大的命令行工具，可以帮助你与 GitHub 进行交互。默认情况下，gh 使用 HTTPS 协议进行认证，但你也可以通过 SSH 协议进行连接，以提高安全性和便利性。本教程将指导你完成使用 SSH 配置 gh login 的完整流程。

前提条件

已安装 GitHub CLI (gh)。如果尚未安装，可以通过以下命令安装：

• macOS: brew install gh

• Linux: sudo apt install gh（或根据发行版使用包管理器）

• Windows: 使用 winget install –id GitHub.cli 或从 GitHub 官方下载。

• 已安装 Git。

• 拥有 GitHub 账户。

生成 SSH 密钥

SSH 连接需要一对公钥和私钥，用于认证你的身份。
打开终端（Linux/Mac）或 Git Bash（Windows）。
输入以下命令生成 SSH 密钥对：

ssh-keygen -t ed25519 -C "你的邮箱@example.com"

-t ed25519 指定使用 Ed25519 算法（更安全且现代）。
-C 添加注释，通常是你的 GitHub 注册邮箱。

按回车接受默认文件位置（通常是 ~/.ssh/id_ed25519）。
输入密码（可选，但建议设置以增加安全性）或直接回车跳过。
完成后，你会在 ~/.ssh/ 目录下看到两个文件：

id_ed25519（私钥) id_ed25519.pub（公钥）

将公钥添加到 GitHub

复制公钥内容到剪贴板：
macOS/Linux: cat ~/.ssh/id_ed25519.pub | pbcopy
Windows (Git Bash): cat ~/.ssh/id_ed25519.pub | clip
或者手动打开文件复制内容。
登录 GitHub 网站（github.com）。
点击右上角头像，选择 Settings > SSH and GPG keys > New SSH key。
在 Title 字段输入描述性名称（例如 “My Laptop”）。
将公钥粘贴到 Key 字段，点击 Add SSH key。

使用 SSH 登录 GitHub CLI

在终端运行：

gh auth login

选择以下选项：
GitHub.com 或 GitHub Enterprise（根据你的需求）。
SSH（选择 SSH 协议，而不是 HTTPS）。
当提示上传 SSH 公钥时：
如果已添加公钥到 GitHub，选择默认路径（例如 ~/.ssh/id_ed25519.pub）。
如果未添加，按照提示上传。
完成认证后，gh 会显示成功登录的消息。
验证登录
运行以下命令检查登录状态：

gh auth status

你应该看到类似以下输出：

github.com
  ✓ Logged in to github.com as 用户名 (SSH)

配置本地 SSH 客户端

测试与 GitHub 的 SSH 连接：

ssh -T git@github.com

如果成功，你会看到类似 Hi 用户名! You've successfully authenticated... 的消息。

配置 Git 使用 SSH

确保你的 Git 使用 SSH 协议与远程仓库通信：
检查当前远程 URL：

git remote -v

如果显示 https://github.com/...，需要改为 SSH。
将远程 URL 改为 SSH 协议：

git remote set-url origin git@github.com:用户名/仓库名.git

常见问题解决

“Permission denied (publickey)”

确保公钥已正确添加到 GitHub。
检查 ssh-agent 是否运行，并已添加私钥。

SSH 密钥文件找不到

确认文件路径是否正确，或重新生成密钥。

总结

通过以上步骤，你已成功配置 gh 使用 SSH 协议登录 GitHub。现在，你可以享受更安全和无缝的 GitHub 操作体验！如果需要进一步操作（如推送代码或创建 PR），只需使用 gh 命令即可。