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
49 lines
1.6 KiB
Groff
49 lines
1.6 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "GIT\-SECRET\-ADD" "1" "March 2019" "sobolevn" "git-secret"
|
|
.
|
|
.SH "NAME"
|
|
\fBgit\-secret\-add\fR \- starts to track added files\.
|
|
.
|
|
.SH "SYNOPSIS"
|
|
.
|
|
.nf
|
|
|
|
git secret add [\-i] <pathspec>\.\.\.
|
|
.
|
|
.fi
|
|
.
|
|
.SH "DESCRIPTION"
|
|
\fBgit\-secret\-add\fR adds a filepath(s) into \fB\.gitsecret/paths/mapping\.cfg\fR and ensures the filepath is mentioned \.gitignore\.
|
|
.
|
|
.P
|
|
When adding files to encrypt, \fBgit\-secret\-add\fR (as of 0\.3\.0) will ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\.
|
|
.
|
|
.P
|
|
If there\'s no users in the \fBgit\-secret\fR\'s keyring, when adding a file, an exception will be raised\.
|
|
.
|
|
.P
|
|
Use the \fBgit secret add\fR command to add filenames to this file\.
|
|
.
|
|
.br
|
|
It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\.
|
|
.
|
|
.P
|
|
(See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information about renaming the \.gitsecret folder using the SECRETS_DIR environment variable\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.nf
|
|
|
|
\-i \- does nothing, adding paths to \.gitignore is now the default behavior\.
|
|
\-h \- shows this help\.
|
|
.
|
|
.fi
|
|
.
|
|
.SH "MANUAL"
|
|
Run \fBman git\-secret\-add\fR to see this note\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
git\-secret\-init(1) \fIhttp://git\-secret\.io/git\-secret\-init\fR, git\-secret\-tell(1) \fIhttp://git\-secret\.io/git\-secret\-tell\fR, git\-secret\-hide(1) \fIhttp://git\-secret\.io/git\-secret\-hide\fR, git\-secret\-reveal(1) \fIhttp://git\-secret\.io/git\-secret\-reveal\fR
|