Documentation / git-credential-store.txton commit Merge branch 'nd/index-pack-threaded-fixes' into maint (f4df84d)
   1git-credential-store(1)
   2=======================
   3
   4NAME
   5----
   6git-credential-store - Helper to store credentials on disk
   7
   8SYNOPSIS
   9--------
  10-------------------
  11git config credential.helper 'store [options]'
  12-------------------
  13
  14DESCRIPTION
  15-----------
  16
  17NOTE: Using this helper will store your passwords unencrypted on disk,
  18protected only by filesystem permissions. If this is not an acceptable
  19security tradeoff, try linkgit:git-credential-cache[1], or find a helper
  20that integrates with secure storage provided by your operating system.
  21
  22This command stores credentials indefinitely on disk for use by future
  23Git programs.
  24
  25You probably don't want to invoke this command directly; it is meant to
  26be used as a credential helper by other parts of git. See
  27linkgit:gitcredentials[7] or `EXAMPLES` below.
  28
  29OPTIONS
  30-------
  31
  32--store=<path>::
  33
  34        Use `<path>` to store credentials. The file will have its
  35        filesystem permissions set to prevent other users on the system
  36        from reading it, but will not be encrypted or otherwise
  37        protected. Defaults to `~/.git-credentials`.
  38
  39EXAMPLES
  40--------
  41
  42The point of this helper is to reduce the number of times you must type
  43your username or password. For example:
  44
  45------------------------------------------
  46$ git config credential.helper store
  47$ git push http://example.com/repo.git
  48Username: <type your username>
  49Password: <type your password>
  50
  51[several days later]
  52$ git push http://example.com/repo.git
  53[your credentials are used automatically]
  54------------------------------------------
  55
  56STORAGE FORMAT
  57--------------
  58
  59The `.git-credentials` file is stored in plaintext. Each credential is
  60stored on its own line as a URL like:
  61
  62------------------------------
  63https://user:pass@example.com
  64------------------------------
  65
  66When Git needs authentication for a particular URL context,
  67credential-store will consider that context a pattern to match against
  68each entry in the credentials file.  If the protocol, hostname, and
  69username (if we already have one) match, then the password is returned
  70to Git. See the discussion of configuration in linkgit:gitcredentials[7]
  71for more information.
  72
  73GIT
  74---
  75Part of the linkgit:git[1] suite