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

43 lines
1.3 KiB
Groff
Raw Normal View History

2016-02-23 21:48:25 +00:00
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
2018-04-14 00:34:54 +00:00
.TH "GIT\-SECRET\-ADD" "1" "April 2018" "sobolevn" "git-secret"
2016-02-23 21:48:25 +00:00
.
.SH "NAME"
\fBgit\-secret\-add\fR \- starts to track added files\.
.
.SH "SYNOPSIS"
.
.nf
git secret add [\-i] <pathspec>\.\.\.
2016-02-23 21:48:25 +00:00
.
.fi
.
.SH "DESCRIPTION"
2018-04-17 04:06:11 +00:00
\fBgit\-secret\-add\fR adds a filepath(es) into \fB\.gitsecret/paths/mapping\.cfg\fR\. When adding files to encrypt, 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\.
2016-02-23 21:48:25 +00:00
.
.P
If there\'s no users in the \fBgit\-secret\fR\'s keyring, when adding a file, an exception will be raised\.
.
.P
2018-04-17 04:06:11 +00:00
Use the \fBgit secret add\fR command to add filenames to thie file\.
.
.br
It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\.
2016-02-23 21:48:25 +00:00
.
.SH "OPTIONS"
.
.nf
2018-04-17 03:43:57 +00:00
\-i \- adds given files to `\.gitignore` if they\'re not there already
2016-02-23 21:48:25 +00:00
\-h \- shows this help\.
.
.fi
.
.SH "MANUAL"
Run \fBman git\-secret\-add\fR to see this note\.
.
2016-02-23 21:48:25 +00:00
.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