Skip to content

Latest commit

 

History

History
107 lines (65 loc) · 5.83 KB

caching-your-github-credentials-in-git.md

File metadata and controls

107 lines (65 loc) · 5.83 KB
Raw
title redirect_from intro versions shortTitle
Caching your GitHub credentials in Git
/firewalls-and-proxies
/articles/caching-your-github-password-in-git
/github/using-git/caching-your-github-password-in-git
/github/using-git/caching-your-github-credentials-in-git
/github/getting-started-with-github/caching-your-github-credentials-in-git
/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git
If you're [cloning {% data variables.product.product_name %} repositories using HTTPS](/github/getting-started-with-github/about-remote-repositories), we recommend you use {% data variables.product.prodname_cli %} or Git Credential Manager (GCM) to remember your credentials.
fpt ghes ghec
*
*
*
Caching credentials

{% tip %}

Tip: If you clone {% data variables.product.product_name %} repositories using SSH, then you can authenticate using an SSH key instead of using other credentials. For information about setting up an SSH connection, see "AUTOTITLE."

{% endtip %}

{% data variables.product.prodname_cli %}

{% data variables.product.prodname_cli %} will automatically store your Git credentials for you when you choose HTTPS as your preferred protocol for Git operations and answer "yes" to the prompt asking if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials.

  1. Install {% data variables.product.prodname_cli %} on macOS, Windows, or Linux.
  2. In the command line, enter gh auth login, then follow the prompts.
    • When prompted for your preferred protocol for Git operations, select HTTPS.
    • When asked if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials, enter Y.

For more information about authenticating with {% data variables.product.prodname_cli %}, see gh auth login.

Git Credential Manager

Git Credential Manager (GCM) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM, you don't have to manually create and store a {% data variables.product.pat_generic %}, as GCM manages authentication on your behalf, including 2FA (two-factor authentication).

{% mac %}

  1. Install Git using Homebrew:

    brew install git

  2. Install GCM using Homebrew:

    brew install --cask git-credential-manager

For macOS, you don't need to run git config because GCM automatically configures Git for you.

{% data reusables.gcm-core.next-time-you-clone %}

Once you've authenticated successfully, your credentials are stored in the macOS keychain and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials.

{% endmac %}

{% windows %}

  1. Install Git for Windows, which includes GCM. For more information, see "Git for Windows releases" from its releases page.

We recommend always installing the latest version. At a minimum, install version 2.29 or higher, which is the first version offering OAuth support for GitHub.

{% data reusables.gcm-core.next-time-you-clone %}

Once you've authenticated successfully, your credentials are stored in the Windows credential manager and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials.


{% warning %}

Warning: Older versions of Git for Windows came with Git Credential Manager for Windows. This older product is no longer supported and cannot connect to GitHub via OAuth. We recommend you upgrade to the latest version of Git for Windows.

{% endwarning %}

{% warning %}

Warning: If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it.

{% endwarning %}

{% endwindows %}

{% linux %}

For Linux, install Git and GCM, then configure Git to use GCM.

  1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run.

  2. Install GCM. See the instructions in the GCM repo, as they'll vary depending on the flavor of Linux you run.

  3. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "GCM Linux."

{% data reusables.gcm-core.next-time-you-clone %}

Once you've authenticated successfully, your credentials are stored on your system and will be used every time you clone an HTTPS URL. Git will not require you to type your credentials in the command line again unless you change your credentials.

For more options for storing your credentials on Linux, see Credential Storage in Pro Git.

{% endlinux %}


For more information or to report issues with GCM, see the official GCM docs at "Git Credential Manager."