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

40 lines
1.4 KiB
Markdown
Raw Normal View History

2016-02-21 13:26:17 +00:00
git-secret-add - starts to track added files.
=============================================
## SYNOPSIS
git secret add [-v] [-i] <pathspec>...
2016-02-21 13:26:17 +00:00
## 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.2.6) 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.
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.
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
2021-06-26 14:17:37 +00:00
(See [git-secret(7)](https://git-secret.io/git-secret) for information about renaming the .gitsecret
folder using the SECRETS_DIR environment variable.
## OPTIONS
-v - verbose, shows extra information.
-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.
2016-02-21 13:26:17 +00:00
## SEE ALSO
2021-06-26 14:17:37 +00:00
[git-secret-init(1)](https://git-secret.io/git-secret-init), [git-secret-tell(1)](https://git-secret.io/git-secret-tell),
[git-secret-hide(1)](https://git-secret.io/git-secret-hide), [git-secret-reveal(1)](https://git-secret.io/git-secret-reveal)