Git Credential Manager Core

Git Credential Manager Core (GCM Core) is a secure Git credential helper built on .NET that runs on Windows, macOS, and Linux.

Compared to Git's built-in credential helpers (Windows: wincred, macOS: osxkeychain, Linux: gnome-keyring/libsecret) which provides single-factor authentication support working on any HTTP-enabled Git repository, GCM Core provides multi-factor authentication support for Azure DevOps, Azure DevOps Server (formerly Team Foundation Server), GitHub, and Bitbucket.

Git Credential Manager Core (GCM Core) replaces the .NET Framework-based Git Credential Manager for Windows (GCM), and the Java-based Git Credential Manager for Mac and Linux (Java GCM), providing a consistent authentication experience across all platforms.

Current status

Git Credential Manager Core is currently available for Windows, macOS, and Linux. GCM only works with HTTP(S) remotes; you can still use Git with SSH:

Feature	Windows	macOS	Linux
Installer/uninstaller	✓	✓	✓*
Secure platform credential storage	✓ Windows Credential Manager	✓ macOS Keychain	✓ 1. Secret Service 2. `pass`/GPG 3. `credential-cache` 4. Plaintext files (see more)
Multi-factor authentication support for Azure DevOps	✓	✓	✓
Two-factor authentication support for GitHub	✓	✓	✓
Two-factor authentication support for Bitbucket	✓	✓	✓
Windows Integrated Authentication (NTLM/Kerberos) support	✓	N/A	N/A
Basic HTTP authentication support	✓	✓	✓
Proxy support	✓	✓	✓

Notes:

(*) Debian package offered but not yet available on an official Microsoft feed.

Download and Install

macOS Homebrew

The preferred installation mechanism is using Homebrew; we offer a Cask in our custom Tap.

To install, run the following:

brew tap microsoft/git
brew install --cask git-credential-manager-core

After installing you can stay up-to-date with new releases by running:

brew upgrade git-credential-manager-core

Git Credential Manager for Mac and Linux (Java-based GCM)

If you have an existing installation of the 'Java GCM' on macOS and you have installed this using Homebrew, this installation will be unlinked (brew unlink git-credential-manager) when GCM Core is installed.

Uninstall

To uninstall, run the following:

brew uninstall --cask git-credential-manager-core

macOS Package

We also provide a .pkg installer with each release. To install, double-click the installation package and follow the instructions presented.

Uninstall

To uninstall, run the following:

sudo /usr/local/share/gcm-core/uninstall.sh

Linux

Debian package (.deb)

apt-get support is available for Ubuntu Bionic Beaver (18.04) and Hirsute Hippo (21.04). Take the following steps to set up and install based on the version you are running:

Ubuntu 18.04 (Bionic)

curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
sudo apt-add-repository https://packages.microsoft.com/ubuntu/18.04/prod
sudo apt-get update
sudo apt-get install gcmcore
git-credential-manager-core configure

Ubuntu 21.04 (Hirsute)

curl -sSL https://packages.microsoft.com/config/ubuntu/21.04/prod.list | sudo tee /etc/apt/sources.list.d/microsoft-prod.list
curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc
sudo apt-get update
sudo apt-get install gcmcore
git-credential-manager-core configure

Other Ubuntu/Debian distributions

Download the latest .deb package, and run the following:

sudo dpkg -i <path-to-package>
git-credential-manager-core configure

Other distributions

Download the latest tarball, and run the following:

tar -xvf <path-to-tarball> -C /usr/local/bin
git-credential-manager-core configure

Note: all Linux distributions require additional configuration to use GCM Core.

Windows

You can download the latest installer for Windows to install GCM Core standalone.

⚠️ Important ⚠️

Installing GCM Core as a standalone package on Windows will forcably override the version of GCM Core that is bundled with Git for Windows, even if the version bundled with Git for Windows is a later version.

There are two flavors of standalone installation on Windows:

User (preferred) (gcmcoreuser-win*):

Does not require administrator rights. Will install only for the current user and updates only the current user's Git configuration.
System (gcmcore-win*):

Requires administrator rights. Will install for all users on the system and update the system-wide Git configuration.

To install, double-click the desired installation package and follow the instructions presented.

Git Credential Manager for Windows

GCM Core installs side-by-side any existing Git Credential Manager for Windows installation and will take precedence over it and use any existing credentials so you shouldn't need to re-authenticate.

Uninstall (Windows 10)

To uninstall, open the Settings app and navigate to the Apps section. Select "Git Credential Manager Core" and click "Uninstall".

Uninstall (Windows 7-8.1)

To uninstall, open Control Panel and navigate to the Programs and Features screen. Select "Git Credential Manager Core" and click "Remove".

How to use

Once it's installed and configured, Git Credential Manager Core is called implicitly by Git. You don't have to do anything special, and GCM Core isn't intended to be called directly by the user. For example, when pushing (git push) to Azure DevOps, Bitbucket, or GitHub, a window will automatically open and walk you through the sign-in process. (This process will look slightly different for each Git host, and even in some cases, whether you've connected to an on-premises or cloud-hosted Git host.) Later Git commands in the same repository will re-use existing credentials or tokens that GCM Core has stored for as long as they're valid.

Read full command line usage here.

Configuring a proxy

See detailed information here.

Additional Resources

Contributing

This project welcomes contributions and suggestions.
See the contributing guide to get started.

This project follows GitHub's Open Source Code of Conduct.

License

We're MIT licensed. When using GitHub logos, please be sure to follow the GitHub logo guidelines.

anorebel / git-credential-manager-core Goto Github PK