Merge branch 'mh/ref-iterators'
[git] / Documentation / git-credential-cache.txt
1 git-credential-cache(1)
2 =======================
3
4 NAME
5 ----
6 git-credential-cache - Helper to temporarily store passwords in memory
7
8 SYNOPSIS
9 --------
10 -----------------------------
11 git config credential.helper 'cache [options]'
12 -----------------------------
13
14 DESCRIPTION
15 -----------
16
17 This command caches credentials in memory for use by future Git
18 programs. The stored credentials never touch the disk, and are forgotten
19 after a configurable timeout.  The cache is accessible over a Unix
20 domain socket, restricted to the current user by filesystem permissions.
21
22 You probably don't want to invoke this command directly; it is meant to
23 be used as a credential helper by other parts of Git. See
24 linkgit:gitcredentials[7] or `EXAMPLES` below.
25
26 OPTIONS
27 -------
28
29 --timeout <seconds>::
30
31         Number of seconds to cache credentials (default: 900).
32
33 --socket <path>::
34
35         Use `<path>` to contact a running cache daemon (or start a new
36         cache daemon if one is not started). Defaults to
37         `~/.git-credential-cache/socket`. If your home directory is on a
38         network-mounted filesystem, you may need to change this to a
39         local filesystem. You must specify an absolute path.
40
41 CONTROLLING THE DAEMON
42 ----------------------
43
44 If you would like the daemon to exit early, forgetting all cached
45 credentials before their timeout, you can issue an `exit` action:
46
47 --------------------------------------
48 git credential-cache exit
49 --------------------------------------
50
51 EXAMPLES
52 --------
53
54 The point of this helper is to reduce the number of times you must type
55 your username or password. For example:
56
57 ------------------------------------
58 $ git config credential.helper cache
59 $ git push http://example.com/repo.git
60 Username: <type your username>
61 Password: <type your password>
62
63 [work for 5 more minutes]
64 $ git push http://example.com/repo.git
65 [your credentials are used automatically]
66 ------------------------------------
67
68 You can provide options via the credential.helper configuration
69 variable (this example drops the cache time to 5 minutes):
70
71 -------------------------------------------------------
72 $ git config credential.helper 'cache --timeout=300'
73 -------------------------------------------------------
74
75 GIT
76 ---
77 Part of the linkgit:git[1] suite