git.oblomov.eu Git - git/blob - 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 requests credentials from the user and caches them in
  18 memory for use by future git programs. The stored credentials never
  19 touch the disk, and are forgotten after a configurable timeout.  The
  20 cache is accessible over a Unix domain socket, restricted to the current
  21 user by filesystem permissions.
  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 linkgit:gitcredentials[7] or `EXAMPLES` below.
  26
  27 OPTIONS
  28 -------
  29
  30 --timeout::
  31
  32         Number of seconds to cache credentials (default: 900).
  33
  34 --socket <path>::
  35
  36         Use `<path>` to contact a running cache daemon (or start a new
  37         cache daemon if one is not started). Defaults to
  38         `~/.git-credential-cache/socket`. If your home directory is on a
  39         network-mounted filesystem, you may need to change this to a
  40         local filesystem.
  41
  42 --chain <helper>::
  43
  44         Specify an external helper to use for retrieving credentials
  45         from the user, instead of the default method. The resulting
  46         credentials are then cached as normal. This option can be
  47         given multiple times; each chained helper will be tried until
  48         credentials are received.
  49
  50 --exit::
  51
  52         Tell a running daemon to exit, forgetting all cached
  53         credentials.
  54
  55 Git may provide other options to the program when it is called as a
  56 credential helper; see linkgit:gitcredentials[7].
  57
  58 EXAMPLES
  59 --------
  60
  61 The point of this helper is to reduce the number of times you must type
  62 your username or password. For example:
  63
  64 ------------------------------------
  65 $ git config credential.helper cache
  66 $ git push http://example.com/repo.git
  67 Username: <type your username>
  68 Password: <type your password>
  69
  70 [work for 5 more minutes]
  71 $ git push http://example.com/repo.git
  72 [your credentials are used automatically]
  73 ------------------------------------
  74
  75 You can provide options via the credential.helper configuration
  76 variable (this example drops the cache time to 5 minutes):
  77
  78 ------------------------------------
  79 $ git config credential.helper 'cache --timeout=300'
  80 ------------------------------------
  81
  82 GIT
  83 ---
  84 Part of the linkgit:git[1] suite