blob: 25652b56cbaedcb936697635369466642e252269 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
'\" t
.\" Title: git-credential-cache
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024-04-16
.\" Manual: Git Manual
.\" Source: Git 2.44.0.651.g21306a098c
.\" Language: English
.\"
.TH "GIT\-CREDENTIAL\-CACHE" "1" "2024\-04\-16" "Git 2\&.44\&.0\&.651\&.g21306a" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-credential-cache \- Helper to temporarily store passwords in memory
.SH "SYNOPSIS"
.sp
.nf
git config credential\&.helper \*(Aqcache [<options>]\*(Aq
.fi
.sp
.SH "DESCRIPTION"
.sp
This command caches credentials for use by future Git programs\&. The stored credentials are kept in memory of the cache\-daemon process (instead of being written to a file) and are forgotten after a configurable timeout\&. Credentials are forgotten sooner if the cache\-daemon dies, for example if the system restarts\&. The cache is accessible over a Unix domain socket, restricted to the current user by filesystem permissions\&.
.sp
You probably don\(cqt want to invoke this command directly; it is meant to be used as a credential helper by other parts of Git\&. See \fBgitcredentials\fR(7) or \fBEXAMPLES\fR below\&.
.SH "OPTIONS"
.PP
\-\-timeout <seconds>
.RS 4
Number of seconds to cache credentials (default: 900)\&.
.RE
.PP
\-\-socket <path>
.RS 4
Use
\fB<path>\fR
to contact a running cache daemon (or start a new cache daemon if one is not started)\&. Defaults to
\fB$XDG_CACHE_HOME/git/credential/socket\fR
unless
\fB~/\&.git\-credential\-cache/\fR
exists in which case
\fB~/\&.git\-credential\-cache/socket\fR
is used instead\&. If your home directory is on a network\-mounted filesystem, you may need to change this to a local filesystem\&. You must specify an absolute path\&.
.RE
.SH "CONTROLLING THE DAEMON"
.sp
If you would like the daemon to exit early, forgetting all cached credentials before their timeout, you can issue an \fBexit\fR action:
.sp
.if n \{\
.RS 4
.\}
.nf
git credential\-cache exit
.fi
.if n \{\
.RE
.\}
.sp
.SH "EXAMPLES"
.sp
The point of this helper is to reduce the number of times you must type your username or password\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git config credential\&.helper cache
$ git push http://example\&.com/repo\&.git
Username: <type your username>
Password: <type your password>
[work for 5 more minutes]
$ git push http://example\&.com/repo\&.git
[your credentials are used automatically]
.fi
.if n \{\
.RE
.\}
.sp
.sp
You can provide options via the credential\&.helper configuration variable (this example increases the cache time to 1 hour):
.sp
.if n \{\
.RS 4
.\}
.nf
$ git config credential\&.helper \*(Aqcache \-\-timeout=3600\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
|
