在 GitHub 上添加 SSH key的步骤如下

310 阅读2分钟

第一步:创建 SSH key

在本地系统中生成 SSH key。如果已经有 SSH key,可以跳过此步骤。

# 生成 ed25519 类型的 SSH key
ssh-keygen -t ed25519 -C "your_email@example.com"

# 或者生成 rsa 类型的 SSH key,需指定 key 大小
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

运行上述命令时会提示输入存储路径和一个验证密码。默认存储路径是 ~/.ssh/id_ed25519~/.ssh/id_rsa,如果你不希望更改路径,请直接按 Enter。

第二步:启动 SSH agent 并添加 SSH key

启动 SSH agent 并配备新的 SSH key。

# 启动 SSH agent
eval "$(ssh-agent -s)"

# 添加 SSH key 到 agent(示例使用 ed25519 类型的 key)
ssh-add ~/.ssh/id_ed25519

# 如果你生成的是 RSA 类型的 key,请使用这个命令
# ssh-add ~/.ssh/id_rsa

第三步:复制 SSH key 到剪贴板

将 SSH key 的公钥部分复制到剪贴板。运行以下命令:

# 适用于 Linux 或 macOS
cat ~/.ssh/id_ed25519.pub | pbcopy

# 或者
cat ~/.ssh/id_rsa.pub | pbcopy

# 适用于 Windows(在 Git Bash 中)
cat ~/.ssh/id_ed25519.pub | clip

# 或者
cat ~/.ssh/id_rsa.pub | clip

第四步:添加 SSH key 到 GitHub

  1. 登录 GitHub:用你的账号登录 GitHub

  2. 导航到 SSH 设置:点击右上角头像 -> Settings -> SSH and GPG keys

  3. 添加新的 SSH key

    1. 点击 New SSH key 按钮。

    2. Title 字段中填入一个描述性名字,如 "My Laptop SSH Key"。

    3. Key 字段中粘贴刚刚复制的公钥部分。

    4. 点击 Add SSH key 按钮确认添加。

第五步:测试 SSH 连接

运行以下命令以确保成功与 GitHub 建立 SSH 连接:

ssh -T git@github.com

如果配置成功,你会看到类似如下的信息:

Hi username! You've successfully authenticated, but GitHub does not provide shell access.

到这一步,你已经成功在 GitHub 上添加了 SSH key,可以开始安全地执行 git 操作了。