1GIT-CREDENTIAL-STO(1)             Git Manual             GIT-CREDENTIAL-STO(1)
2
3
4

NAME

6       git-credential-store - Helper to store credentials on disk
7

SYNOPSIS

9       git config credential.helper 'store [<options>]'
10
11

DESCRIPTION

13           Note
14           Using this helper will store your passwords unencrypted on disk,
15           protected only by filesystem permissions. If this is not an
16           acceptable security tradeoff, try git-credential-cache(1), or find
17           a helper that integrates with secure storage provided by your
18           operating system.
19
20       This command stores credentials indefinitely on disk for use by future
21       Git programs.
22
23       You probably don’t want to invoke this command directly; it is meant to
24       be used as a credential helper by other parts of git. See
25       gitcredentials(7) or EXAMPLES below.
26

OPTIONS

28       --file=<path>
29           Use <path> to lookup and store credentials. The file will have its
30           filesystem permissions set to prevent other users on the system
31           from reading it, but will not be encrypted or otherwise protected.
32           If not specified, credentials will be searched for from
33           ~/.git-credentials and $XDG_CONFIG_HOME/git/credentials, and
34           credentials will be written to ~/.git-credentials if it exists, or
35           $XDG_CONFIG_HOME/git/credentials if it exists and the former does
36           not. See also the section called “FILES”.
37

FILES

39       If not set explicitly with --file, there are two files where
40       git-credential-store will search for credentials in order of
41       precedence:
42
43       ~/.git-credentials
44           User-specific credentials file.
45
46       $XDG_CONFIG_HOME/git/credentials
47           Second user-specific credentials file. If $XDG_CONFIG_HOME is not
48           set or empty, $HOME/.config/git/credentials will be used. Any
49           credentials stored in this file will not be used if
50           ~/.git-credentials has a matching credential as well. It is a good
51           idea not to create this file if you sometimes use older versions of
52           Git that do not support it.
53
54       For credential lookups, the files are read in the order given above,
55       with the first matching credential found taking precedence over
56       credentials found in files further down the list.
57
58       Credential storage will by default write to the first existing file in
59       the list. If none of these files exist, ~/.git-credentials will be
60       created and written to.
61
62       When erasing credentials, matching credentials will be erased from all
63       files.
64

EXAMPLES

66       The point of this helper is to reduce the number of times you must type
67       your username or password. For example:
68
69           $ git config credential.helper store
70           $ git push http://example.com/repo.git
71           Username: <type your username>
72           Password: <type your password>
73
74           [several days later]
75           $ git push http://example.com/repo.git
76           [your credentials are used automatically]
77
78

STORAGE FORMAT

80       The .git-credentials file is stored in plaintext. Each credential is
81       stored on its own line as a URL like:
82
83           https://user:pass@example.com
84
85
86       When Git needs authentication for a particular URL context,
87       credential-store will consider that context a pattern to match against
88       each entry in the credentials file. If the protocol, hostname, and
89       username (if we already have one) match, then the password is returned
90       to Git. See the discussion of configuration in gitcredentials(7) for
91       more information.
92

GIT

94       Part of the git(1) suite
95
96
97
98Git 2.24.1                        12/10/2019             GIT-CREDENTIAL-STO(1)