@@ -19,6 +19,10 @@ Git Credential Manager (GCM) replaces the .NET Framework-based
1919[ Git Credential Manager for Mac and Linux] [ gcm-for-mac-and-linux ] (Java GCM),
2020providing a consistent authentication experience across all platforms.
2121
22+ ## Install
23+
24+ See [ installation instructions] [ install ] for your operating system.
25+
2226## Current status
2327
2428Git Credential Manager is currently available for Windows, macOS, and Linux\* .
@@ -53,186 +57,10 @@ fully-supported.
5357- Fedora/CentOS/RHEL
5458- Alpine
5559
56- ## Download and Install
57-
58- ### macOS Homebrew
59-
60- The preferred installation mechanism is using Homebrew; we offer a Cask in our
61- custom Tap.
62-
63- To install, run the following:
64-
65- ``` shell
66- brew tap microsoft/git
67- brew install --cask git-credential-manager-core
68- ```
69-
70- After installing you can stay up-to-date with new releases by running:
71-
72- ``` shell
73- brew upgrade git-credential-manager-core
74- ```
75-
76- #### Git Credential Manager for Mac and Linux (Java-based GCM)
77-
78- If you have an existing installation of the 'Java GCM' on macOS and you have
79- installed this using Homebrew, this installation will be unlinked
80- (` brew unlink git-credential-manager ` ) when GCM is installed.
81-
82- #### Uninstall
83-
84- To uninstall, run the following:
85-
86- ``` shell
87- brew uninstall --cask git-credential-manager-core
88- ```
89-
90- ---
91-
92- ### macOS Package
93-
94- We also provide a [ .pkg installer] [ latest-release ] with each release. To install,
95- double-click the installation package and follow the instructions presented.
96-
97- #### Uninstall
98-
99- To uninstall, run the following:
100-
101- ``` shell
102- sudo /usr/local/share/gcm-core/uninstall.sh
103- ```
104-
105- ---
106-
107- <!-- this explicit anchor should stay stable so that external docs can link here -->
108- <!-- markdownlint-disable-next-line no-inline-html -->
109- <a name =" linux-install-instructions " ></a >
110-
111- ### Linux
112-
113- #### Ubuntu/Debian distributions
114-
115- Download the latest [ .deb package] [ latest-release ] , and run the following:
116-
117- ``` shell
118- sudo dpkg -i < path-to-package>
119- git-credential-manager configure
120- ```
121-
122- ** Note:** Although packages were previously offered on certain
123- [ Microsoft Ubuntu package feeds] [ ms-package-repos ] ,
124- GCM no longer publishes to these repositories. Please install the
125- Debian package using the above instructions instead.
126-
127- To uninstall:
128-
129- ``` shell
130- git-credential-manager unconfigure
131- sudo dpkg -r gcmcore
132- ```
133-
134- #### Other distributions
135-
136- ##### Option 1: Tarball
137-
138- Download the latest [ tarball] [ latest-release ] , and run the following:
139-
140- ``` shell
141- tar -xvf < path-to-tarball> -C /usr/local/bin
142- git-credential-manager configure
143- ```
144-
145- To uninstall:
146-
147- ``` shell
148- git-credential-manager unconfigure
149- rm $( command -v git-credential-manager)
150- ```
151-
152- #### Option 2: Install from source helper script
153-
154- 1 . Ensure ` curl ` is installed:
155-
156- ``` shell
157- curl --version
158- ```
159-
160- If ` curl ` is not installed, please use your distribution's package manager
161- to install it.
162-
163- 1 . Download and run the script:
164-
165- ``` shell
166- curl -LO https://aka.ms/gcm/linux-install-source.sh &&
167- sh ./linux-install-source.sh &&
168- git-credential-manager-core configure
169- ```
170-
171- ** Note:** You will be prompted to enter your credentials so that the script
172- can download GCM's dependencies using your distribution's package
173- manager.
174-
175- To uninstall:
176-
177- [ Follow these instructions] [ linux-uninstall ] for your distribution.
178-
179- ** Note:** all Linux distributions
180- [ require additional configuration] [ gcm-credstores ] to use GCM.
181-
182- ---
183-
184- ### Windows
185-
186- GCM is included with [ Git for Windows] [ git-for-windows ] , and the latest version
187- is included in each new Git for Windows release. This is the preferred way to
188- install GCM on Windows. During installation you will be asked to select a
189- credential helper, with GCM being set as the default.
190-
191- ![ image] [ git-for-windows-screenshot ]
192-
193- #### Standalone installation
194-
195- You can also download the [ latest installer] [ latest-release ] for Windows to
196- install GCM standalone.
197-
198- ** :warning : Important :warning : **
199-
200- Installing GCM as a standalone package on Windows will forcibly override the
201- version of GCM that is bundled with Git for Windows, ** even if the version
202- bundled with Git for Windows is a later version** .
203-
204- There are two flavors of standalone installation on Windows:
205-
206- - User (preferred) (` gcmuser-win* ` ):
207-
208- Does not require administrator rights. Will install only for the current user
209- and updates only the current user's Git configuration.
210-
211- - System (` gcm-win* ` ):
212-
213- Requires administrator rights. Will install for all users on the system and
214- update the system-wide Git configuration.
215-
216- To install, double-click the desired installation package and follow the
217- instructions presented.
218-
219- #### Uninstall (Windows 10)
220-
221- To uninstall, open the Settings app and navigate to the Apps section. Select
222- "Git Credential Manager" and click "Uninstall".
223-
224- #### Uninstall (Windows 7-8.1)
225-
226- To uninstall, open Control Panel and navigate to the Programs and Features
227- screen. Select "Git Credential Manager" and click "Remove".
228-
229- #### Windows Subsystem for Linux (WSL)
230-
231- Git Credential Manager can be used with the [ Windows Subsystem for Linux
232- (WSL)] [ ms-wsl ] to enable secure authentication of your remote Git
233- repositories from inside of WSL.
60+ ## Install
23461
235- [ Please see the GCM on WSL docs] [ gcm-wsl ] for more information.
62+ See [ install.md] ( install ) for installation instructions for your operating
63+ system.
23664
23765## Supported Git versions
23866
@@ -328,15 +156,10 @@ When using GitHub logos, please be sure to follow the
328156[ gcm-net-config ] : docs/netconfig.md
329157[ gcm-usage ] : docs/usage.md
330158[ gcm-windows-broker ] : docs/windows-broker.md
331- [ gcm-wsl ] : docs/wsl.md
332- [ git-for-windows ] : https://gitforwindows.org/
333- [ git-for-windows-screenshot ] : https://user-images.githubusercontent.com/5658207/140082529-1ac133c1-0922-4a24-af03-067e27b3988b.png
334159[ git-tools-credential-storage ] : https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage
335160[ github ] : https://github.com
336161[ github-ssh ] : https://help.github.com/en/articles/connecting-to-github-with-ssh
337162[ github-logos ] : https://github.com/logos
338- [ latest-release ] : https://github.com/GitCredentialManager/git-credential-manager/releases/latest
339- [ linux-uninstall ] : docs/linux-fromsrc-uninstall.md
163+ [ install ] : docs/install.md
340164[ ms-package-repos ] : https://packages.microsoft.com/repos/
341- [ ms-wsl ] : https://aka.ms/wsl#
342165[ workflow-status ] : https://github.com/GitCredentialManager/git-credential-manager/actions/workflows/continuous-integration.yml
0 commit comments