mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-18 15:26:58 +00:00
ce8c6b3ae0
* Change 'add' to add to .gitignore by default. Also add _message() function and improve output from 'git-secret-add', alter tests for new code behavior, and update docs. * change tests since 'add' always adds to .gitignore * improve output: prepend more message with 'git-secret:'. * update man page for git-secret-add
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
git-secret-add - starts to track added files.
|
|
=============================================
|
|
|
|
## SYNOPSIS
|
|
|
|
git secret add [-i] <pathspec>...
|
|
|
|
|
|
## DESCRIPTION
|
|
`git-secret-add` adds a filepath(s) into `.gitsecret/paths/mapping.cfg`
|
|
and ensures the filepath is mentioned .gitignore.
|
|
|
|
When adding files to encrypt, `git-secret-add` (as of 0.3.0) will 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.
|
|
|
|
If there's no users in the `git-secret`'s keyring, when adding a file, an exception will be raised.
|
|
|
|
Use the `git secret add` command to add filenames to this file.
|
|
It is not recommended to add filenames directly into `.gitsecret/paths/mapping.cfg`.
|
|
|
|
(See [git-secret(7)](http://git-secret.io/git-secret) for information about renaming the .gitsecret
|
|
folder using the SECRETS_DIR environment variable.
|
|
|
|
## OPTIONS
|
|
|
|
-i - does nothing, adding paths to .gitignore is now the default behavior.
|
|
-h - shows this help.
|
|
|
|
|
|
## MANUAL
|
|
|
|
Run `man git-secret-add` to see this note.
|
|
|
|
|
|
## SEE ALSO
|
|
|
|
[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)
|