Skip to main content

Authenticating to GitHub in GitHub Desktop

You can securely access your account's resources on GitHub Desktop by authenticating to GitHub.

Platform navigation

About authentication

To keep your account secure, you must authenticate before you can use GitHub Desktop to access resources on GitHub.

Before you authenticate, 你必须在 GitHub.com 上拥有帐户。有关详细信息,请参阅“注册新 GitHub 帐户”。

Authenticating an account on GitHub

  1. 在菜单栏中,选择 GitHub Desktop,然后单击“首选项”。

    Mac 上的菜单栏的屏幕截图。 在打开的“GitHub Desktop”下拉菜单下,光标悬停在“首选项”上,后者呈蓝色突出显示。

  2. In the "Preferences" window, on the Accounts pane, click the Sign In button next to "GitHub.com".

    Screenshot of the "Accounts" pane in the "Preferences" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.

  3. 在“使用浏览器登录”模型窗口中,单击“继续使用浏览器”。 GitHub Desktop 将打开您的默认浏览器。

  4. 要向 GitHub 进行身份验证,请在浏览器中输入你的 GitHub.com 凭据,然后单击“登录”。

    或者,如果您已登录 GitHub,请按照提示返回 GitHub Desktop 完成身份验证。

  5. 如果已为 GitHub 配置双重身份验证 (2FA),请执行以下操作之一:

    • 如果通过 SMS 设置 2FA,则从 SMS 消息检索 2FA 代码 。
    • 如果使用 TOTP 应用程序设置 2FA,则生成 2FA 代码。

    然后在 GitHub 的提示中输入你的 2FA 代码,然后单击“验证”。

  6. After GitHub authenticates your account, follow the prompts to return to GitHub Desktop.

Authenticating an account on GitHub Enterprise Server

  1. 在菜单栏中,选择 GitHub Desktop,然后单击“首选项”。

    Mac 上的菜单栏的屏幕截图。 在打开的“GitHub Desktop”下拉菜单下,光标悬停在“首选项”上,后者呈蓝色突出显示。

  2. In the "Preferences" window, on the Accounts pane, click the Sign In button next to "GitHub Enterprise".

    Screenshot of the "Accounts" pane in the "Preferences" window. Next to "GitHub Enterprise", a button, labeled "Sign In", is outlined in orange.

  3. To add an account on 你的 GitHub Enterprise Server 实例, in the "Sign in" modal window, type the URL for your instance under "Enterprise address," then click Continue.

  4. 在“使用浏览器登录”模型窗口中,单击“继续使用浏览器”。 GitHub Desktop 将打开您的默认浏览器。

  5. To authenticate to 你的 GitHub Enterprise Server 实例 account, type your account credentials and click Sign in.

    Alternatively, if you were already signed in to 你的 GitHub Enterprise Server 实例 account, follow the prompts to return to GitHub Desktop to finish authenticating.

Authenticating an account on GitHub

  1. 使用文件”菜单,然后单击“选项” 。

    Windows 上的“GitHub Desktop”菜单栏的屏幕截图。 在展开的“文件”下拉菜单中,“选项”项以橙色边框突出显示。

  2. In the "Options" window, on the Accounts pane, click the Sign In button next to "GitHub.com".

    Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.

  3. 在“使用浏览器登录”模型窗口中,单击“继续使用浏览器”。 GitHub Desktop 将打开您的默认浏览器。

    警告:不支持使用用户名和密码对 GitHub 进行身份验证。 我们要求使用浏览器进行身份验证。

  4. 要向 GitHub 进行身份验证,请在浏览器中输入你的 GitHub.com 凭据,然后单击“登录”。

    或者,如果您已登录 GitHub,请按照提示返回 GitHub Desktop 完成身份验证。

  5. 如果已为 GitHub 配置双重身份验证 (2FA),请执行以下操作之一:

    • 如果通过 SMS 设置 2FA,则从 SMS 消息检索 2FA 代码 。
    • 如果使用 TOTP 应用程序设置 2FA,则生成 2FA 代码。

    然后在 GitHub 的提示中输入你的 2FA 代码,然后单击“验证”。

  6. After GitHub authenticates your account, follow the prompts to return to GitHub Desktop.

Authenticating an account on GitHub Enterprise

  1. 使用文件”菜单,然后单击“选项” 。

    Windows 上的“GitHub Desktop”菜单栏的屏幕截图。 在展开的“文件”下拉菜单中,“选项”项以橙色边框突出显示。

  2. In the "Options" window, on the Accounts pane, click the Sign In button next to "GitHub Enterprise".

    Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub Enterprise", a button, labeled "Sign In", is outlined in orange.

  3. To add a GitHub Enterprise account, type your credentials under "Enterprise address," then click Continue.

  4. 如果你为 GitHub Enterprise 配置了双重身份验证,请执行以下操作之一:

    • 如果通过 SMS 设置 2FA,则从 SMS 消息检索 2FA 代码 。
    • 如果使用 TOTP 应用程序设置 2FA,则生成 2FA 代码。

Troubleshooting authentication issues

If GitHub Desktop encounters an authentication error, you can use error messages to troubleshoot.

If you encounter an authentication error, first try signing out and signing back in to your account on GitHub Desktop.

For some errors, GitHub Desktop will prompt you with an error message. If you are not prompted, or to find more information about any error, view the GitHub Desktop log files by using the following steps.

  1. In the menu bar, select Help, then click Show Logs in Finder.

    Screenshot of the "GitHub Desktop" menu bar on a Mac. Under the expanded "Help" dropdown menu, a cursor hovers over "Show Logs in Finder", highlighted in blue.

  2. Select the log file from the date when you encountered the authentication error.

  1. Use the Help drop-down menu and click Show Logs in Explorer.

    Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "Help" dropdown menu, an option labeled "Show Logs in Explorer" is outlined in orange.

  2. Select the log file from the date when you encountered the authentication error.

Review the troubleshooting information below for the error message that you encounter.

Bad credentials

Error: Bad credentials

This error means that there is an issue with your stored account credentials.

To troubleshoot, sign out of your account on GitHub Desktop and then sign back in.

Empty token

info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - USERNAME (empty token)

This error means that GitHub Desktop is unable to find the access token that it created in the system keychain.

To troubleshoot, sign out of your account on GitHub Desktop and then sign back in.

Repository not found

fatal: repository 'https://github.com/<user>/<repo>.git' not found

(The error was parsed as 8: The repository does not seem to exist anymore. You may not have access, or it may have been deleted or renamed.)

This error means that you do not have permission to access the repository that you are trying to clone.

To troubleshoot, contact the person in your organization who administers permissions.

Could not read from remote repository

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights and the repository exists.

This error means that you do not have a valid SSH key set up.

To troubleshoot, see "生成新的 SSH 密钥并将其添加到 ssh-agent."

Failed to clone

fatal: clone of 'git@github.com:<user>/<repo>' into submodule path '<path>' failed
Failed to clone 'src/github.com/<user>/<repo>'. Retry scheduled
Cloning into '<path>'...
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.

This error means that either the repository that you are trying to clone has submodules that you do not have access to or you do not have a valid SSH key set up.

If you do not have access to the submodules, troubleshoot by contacting the person who administers permissions for the repository.

If you do not have a valid SSH key set up, see "生成新的 SSH 密钥并将其添加到 ssh-agent."

Unable to read AskPass response

error: unable to read askpass response from '/Users/<path>/GitHub Desktop.app/Contents/Resources/app/static/ask-pass-trampoline.sh'
fatal: could not read Username for 'https://github.com': terminal prompts disabled

This error can be caused by multiple events.

If the Command Processor registry entries are modified, GitHub Desktop will respond with an Authentication failed error. To check if these registry entries have been modified, follow these steps.

  1. Open the Registry Editor (regedit.exe) and navigate to the following locations. HKEY_CURRENT_USER\Software\Microsoft\Command Processor\ HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\
  2. Check to see if there is an Autorun value in either location.
  3. If there is an Autorun value, delete it.

If your Windows username has extended Unicode characters, it may cause an AskPass response error. To troubleshoot, create a new Windows user account and migrate your files to that account. For more information, see "Create a user account in Windows" in the Microsoft documentation.

Further reading