在使用 GitHub 进行开发时，为了方便，我们一般会将代码仓库克隆到本地进行开发，但是在进行 push 或者 pull 操作时，仍需要输入 GitHub 用户名和密码，这样就会有一定的安全隐患。在这种情况下，我们可以通过生成 SSH key 并将公钥添加到 GitHub 账户中来解决这个问题。但是，对于新手来说，可能并不是很熟悉在本地生成和添加公钥的步骤。
这时，npm 包 github-add-key 就起到了很重要的作用，它可以让我们在本地快速生成并添加 SSH 公钥到 GitHub 账户中。
npm 包 github-add-key
npm 包 github-add-key 可以通过 npm 安装，它的主要作用是对 git 命令进行扩展，方便我们在本地生成和添加 SSH 公钥。使用 github-add-key 的过程中，需要注意下面的一些安全事项：
- 执行 github-add-key 命令的用户需要有对 github 帐户的写权限；
- 生成的 SSH 公钥仅用于与 Github 帐户进行通信，不应该在其他地方使用；
- 生成的 SSH 私钥应该妥善保管，不要直接提交到代码仓库或交给其他人；
- 切勿将 SSH 私钥文件、密钥口令或其他敏感信息泄露给他人。
github-add-key 安装
使用 npm 安装 github-add-key 非常简单，只需要在终端中输入下面的命令即可：
npm install -g github-add-key
如果在安装过程中出现了权限不足的错误提示，则说明需要使用管理员权限，可以在命令前加上 sudo。
sudo npm install -g github-add-key
生成 SSH 公钥并添加到 Github 账户中
使用 github-add-key 生成 SSH 公钥并添加到 Github 账户中很简单，只需要在终端中输入下面的命令即可：
github-add-key <github-username> --title '<title>'
其中，<github-username> 是你在 Github 上注册的用户名，<title> 是你的 SSH key 的名称。执行完该命令后，会在 ~/.ssh 目录下生成 id_rsa 和 id_rsa.pub 两个文件。其中 id_rsa 是私钥，id_rsa.pub 是公钥。public key 就是要添加到 Github 上的 Key。
接下来，需要将公钥添加到 Github 账户中。
- 进入 Github 主界面，点击头像进入 Settings；
- 然后点击左侧菜单中的 SSH and GPG keys；
- 点击右上角的 New SSH key，将公钥内容复制到 Key 框中；
- 点击 Add SSH key 按钮保存即可。
此时，我们已经成功生成了 SSH 公钥，并且添加到了 Github 账户中。
示例代码
下面是使用 github-add-key 生成 SSH 公钥并添加到 Github 账户中的完整示例代码：
# 安装 github-add-key npm install -g github-add-key # 生成 SSH 公钥并添加到 Github 账户中 github-add-key <github-username> --title '<title>'
其中，<github-username> 是你在 Github 上注册的用户名，<title> 是你的 SSH key 的名称。执行完该命令后，会在 ~/.ssh 目录下生成 id_rsa 和 id_rsa.pub 两个文件。我们只需要将 id_rsa.pub 中的内容复制到 Github 账户中即可完成添加。
总结
github-add-key 是一个非常实用的 npm 包，它可以帮助我们快速生成 SSH 公钥，并将公钥添加到 Github 账户中。使用 github-add-key 需要注意安全事项，确保生成的 SSH 公钥只在与 Github 账户进行通信时使用，并妥善保管私钥文件和密钥口令。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600552c381e8991b448d028c