GitHub 是常用的代码托管平台,可以用来管理项目代码、记录版本修改和参与开源项目。
第一次使用 GitHub,除了注册账号,还需要安装 Git、配置用户名和邮箱,以及设置 SSH Key,才能方便地在本地电脑和 GitHub 之间同步代码。
本文以 Windows 10/11 为例,完整走一遍配置流程。
一、注册 GitHub 账号
第 1 步:进入注册页面
打开 GitHub 官网:点击右上角的 Sign up,进入注册页面。
第 2 步:填写注册信息
根据页面提示完成账号注册,包括:
-
邮箱地址
-
登录密码或其他身份验证方式
-
用户名
-
页面要求的安全验证
GitHub 支持使用邮箱注册,也支持部分第三方账号登录。
用户名建议使用英文、数字等符合平台规则的字符,因为后续创建仓库时,用户名会出现在仓库地址中。
第 3 步:验证邮箱
根据注册流程完成邮箱验证。
完成后登录 GitHub,即可进入个人账号页面。
如果没有验证邮箱,部分功能可能无法正常使用,例如创建代码仓库。
建议注册完成后开启双重身份验证(2FA),提高账号安全性。
二、安装 Git
Git 和 GitHub 不是同一个工具。
Git 是本地版本控制软件,GitHub 是提供远程代码仓库的平台。
需要通过命令行上传、下载或同步代码时,通常要先安装 Git。
第 1 步:下载安装程序
访问 Git 官方网站:
选择 Windows 版本,根据系统架构下载对应安装程序。
安装过程中,如果没有特殊需求,普通用户可以保留默认配置。
第 2 步:检查安装结果
安装完成后,在 Windows 开始菜单中找到 Git Bash 并打开。
输入:
git --version
如果显示类似下面的版本信息:
git version 2.x.x
说明 Git 已安装成功。
这里的版本号仅为示例,以电脑实际输出为准。
三、配置 Git 用户名和邮箱
Git 安装完成后,需要设置提交代码时使用的身份信息。
打开 Git Bash,执行以下命令:
git config --global user.name "yourname"
git config --global user.email "your_email@example.com"
将 yourname 和邮箱地址替换成自己的信息。
建议邮箱使用 GitHub 账号中已经验证过的邮箱,或 GitHub 提供的隐私保护邮箱,以便正确关联提交记录。
配置完成后,检查信息:
git config --global user.name
git config --global user.email
如果终端返回刚才设置的用户名和邮箱,说明配置成功。
注意:这里设置的是 Git 提交记录的作者身份,不是 GitHub 的登录凭证,也不代表已经完成 SSH 认证。
四、生成 SSH Key
SSH Key 用于验证本地电脑与 GitHub 之间的身份。
使用 SSH 方式连接仓库时,可以通过密钥进行认证,不必在每次 Git 操作时输入 GitHub 账号密码。
1. 检查是否已有 SSH Key
在 Git Bash 输入:
ls -al ~/.ssh
如果看到以下文件:
id_ed25519
id_ed25519.pub
说明电脑中可能已经存在 Ed25519 密钥对。
其中:
-
id_ed25519:私钥,必须保存在本地,不能泄露。 -
id_ed25519.pub:公钥,可以添加到 GitHub。
如果已有 SSH Key,应先确认它是否用于其他服务,不要直接覆盖。
2. 生成新的 SSH Key
如果没有可用密钥,可以执行:
ssh-keygen -t ed25519 -C "your_email@example.com"
其中 -t ed25519 表示使用 Ed25519 算法,-C 用于添加注释,通常填写邮箱方便识别。
运行后,终端会提示选择密钥保存路径:
Enter file in which to save the key:
首次配置且默认路径没有同名文件时,可以直接按 Enter。
随后提示设置密钥密码:
Enter passphrase:
Enter same passphrase again:
建议设置一个用于保护私钥的密码,输入时终端不会显示字符。
完成后,默认会在用户目录的 .ssh 文件夹中生成公钥和私钥。
3. 将私钥添加到 ssh-agent
在 Git Bash 中执行:
eval "$(ssh-agent -s)"
启动当前会话中的 SSH 代理。
然后执行:
ssh-add ~/.ssh/id_ed25519
如果之前设置了密钥密码,按提示输入。
如果使用了自定义密钥文件名,需要相应修改路径。
五、将 SSH 公钥添加到 GitHub
第 1 步:查看公钥
在 Git Bash 中执行:
cat ~/.ssh/id_ed25519.pub
终端会输出以 ssh-ed25519 开头的一行内容。
复制完整公钥。
不要复制没有 .pub 后缀的私钥文件内容。
第 2 步:进入 GitHub SSH 设置
登录 GitHub,依次进入:
Settings → SSH and GPG keys → New SSH key
第 3 步:添加公钥
按照页面要求填写:
-
Title:例如
My Windows PC -
Key type:选择
Authentication Key -
Key:粘贴刚才复制的公钥
点击 Add SSH key 保存。
GitHub 可能要求再次验证账号身份,按照页面提示完成即可。
六、测试 SSH 连接
完成公钥添加后,回到 Git Bash。
执行:
ssh -T git@github.com
首次连接时,终端可能提示确认 GitHub 服务器的身份。
应先将显示的 SSH 主机指纹与 GitHub 官方公布的指纹核对,确认一致后输入:
yes
如果配置成功,会看到类似提示:
Hi yourname! You've successfully authenticated,
but GitHub does not provide shell access.
这说明 GitHub 已经识别当前 SSH 密钥。
注意:GitHub 不提供普通 SSH Shell 登录,因此该测试命令即使认证成功,也可能返回非零退出状态。应根据实际提示判断连接是否成功。
七、创建第一个 GitHub 仓库
SSH 配置完成后,可以创建一个仓库进行测试。
第 1 步:创建远程仓库
登录 GitHub,点击右上角的 +,选择 New repository。
填写:
-
Repository name:
git-demo -
Description:可以留空
-
Visibility:选择 Public 或 Private
这次使用本地代码初始化仓库,因此先不要勾选添加 README、.gitignore 或 License。
点击 Create repository。
第 2 步:创建本地项目
打开 Git Bash,依次执行:
mkdir git-demo
cd git-demo
git init
创建一个 README 文件:
echo "# Git Demo" > README.md
将文件加入版本管理:
git add README.md
提交代码:
git commit -m "Initial commit"
设置分支名称:
git branch -M main
第 3 步:关联 GitHub 远程仓库
执行:
git remote add origin git@github.com:yourname/git-demo.git
把 yourname 替换成自己的 GitHub 用户名。
这里使用的是 SSH 仓库地址,而不是 HTTPS 地址。
可以通过下面的命令确认远程地址:
git remote -v
第 4 步:推送代码
执行:
git push -u origin main
如果 SSH 认证正常,并且当前账号具有仓库写入权限,Git 会将本地提交推送到远程仓库。
完成后刷新 GitHub 的仓库页面。
如果可以看到 README.md 文件,说明本地 Git、SSH 认证和远程仓库推送流程都已正常完成。
GitHub 免费功能与付费服务
GitHub 的基础代码托管、Git 操作和 SSH Key 配置均可免费使用。对于需要 GitHub Copilot、GitHub Actions 超额用量等付费功能的用户,可以在账号的 Billing 页面查看计费规则及支持的付款方式。
如果涉及海外开发工具的订阅费用,也可以了解 像是MXK8 梦想出海的 Visa、Master 虚拟卡,需以 GitHub 的实际支付要求和发卡机构规则为准。
八、常见错误及解决方法
1. Permission denied (publickey)
常见原因:
-
SSH 公钥未添加到 GitHub
-
当前使用的密钥不是已注册的密钥
-
私钥未正确加载
-
SSH 客户端使用了其他密钥
先检查:
ssh-add -l
如果没有显示当前密钥,可以重新执行:
ssh-add ~/.ssh/id_ed25519
必要时使用下面的命令查看 SSH 认证调试信息:
ssh -vT git@github.com
根据日志检查实际使用的密钥。
2. Repository not found
检查远程仓库地址:
git remote -v
确认仓库名称、用户名及权限是否正确。
如果仓库属于其他账号或组织,还要确认当前 GitHub 账号是否具有访问权限。
3. Author identity unknown
说明 Git 尚未获得提交作者信息。
重新设置:
git config --global user.name "yourname"
git config --global user.email "your_email@example.com"
然后再执行提交操作。
4. git: command not found
通常说明 Git 没有正确安装,或者当前终端无法找到 Git 可执行文件。
可以重新安装 Git,并使用 Git Bash 检查版本。