gh-auth-setup-git1
Setup git with github cli
Usage
gh auth
setup-git
[flags]
Overview
This command configures git to use GitHub CLI as a credential helper. For more information on git credential helpers please reference:
⟨https://git-scm.com/docs/gitcredentials⟩.
By default, GitHub CLI will be set as the credential helper for all authenticated hosts. If there is no authenticated hosts the command fails with an error.
Alternatively, use the --hostname flag to specify a single host to be configured. If the host is not authenticated with, the command fails with an error.
Options
-
-f, --force <--hostname> -
Force setup even if the host is not known. Must be used in conjunction with --hostname
-
-h, --hostname <string> -
The hostname to configure git for
Exit status
0: Successful execution
1: Error
2: Command canceled
4: Authentication required
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.
Examples
# Configure git to use GitHub CLI as the credential helper for all authenticated hosts $ gh auth setup-git # Configure git to use GitHub CLI as the credential helper for enterprise.internal host $ gh auth setup-git --hostname enterprise.internal
Releases
3 releases since Debian 12 (Bookworm); the text changed 2 times.
--force since Debian 13 (Trixie);
-f since Debian 13 (Trixie).