git-secret/man/man1/git-secret-add.1.ronn

38 lines
1.2 KiB
Plaintext
Raw Normal View History

2016-02-21 13:26:17 +00:00
git-secret-add - starts to track added files.
=============================================
## SYNOPSIS
git secret add [-i] <pathspec>...
2016-02-21 13:26:17 +00:00
## DESCRIPTION
2018-08-26 17:29:15 +00:00
`git-secret-add` adds a filepath(s) into `.gitsecret/paths/mapping.cfg`.
2018-04-17 03:43:57 +00:00
When adding files to encrypt, ensure that they are ignored by `git` by mentioning
them in .gitignore, since they must be secure and not be committed into the remote repository unencrypted.
2016-02-21 13:26:17 +00:00
If there's no users in the `git-secret`'s keyring, when adding a file, an exception will be raised.
2018-04-17 15:23:10 +00:00
Use the `git secret add` command to add filenames to this file.
2018-04-17 03:43:57 +00:00
It is not recommended to add filenames directly into `.gitsecret/paths/mapping.cfg`.
2016-02-21 13:26:17 +00:00
(See [git-secret(7)](http://git-secret.io/git-secret) for information about renaming the .gitsecret
folder using the SECRETS_DIR environment variable.
## OPTIONS
2018-04-17 03:43:57 +00:00
-i - adds given files to `.gitignore` if they're not there already
-h - shows this help.
## MANUAL
Run `man git-secret-add` to see this note.
2016-02-21 13:26:17 +00:00
## SEE ALSO
2018-04-17 04:06:11 +00:00
[git-secret-init(1)](http://git-secret.io/git-secret-init), [git-secret-tell(1)](http://git-secret.io/git-secret-tell),
[git-secret-hide(1)](http://git-secret.io/git-secret-hide), [git-secret-reveal(1)](http://git-secret.io/git-secret-reveal)