man1/git-credential-cache.1

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