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

47 lines
1.6 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
.
2021-05-03 13:18:15 +00:00
.TH "GIT\-SECRET\-ADD" "1" "May 2021" "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
2020-10-04 19:20:24 +00:00
git secret add [\-v] [\-i] <pathspec>\.\.\.
2016-02-23 21:48:25 +00:00
.
.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\.
2018-08-26 17:26:15 +00:00
.
.P
When adding files to encrypt, \fBgit\-secret\-add\fR (as of 0\.2\.6) 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\.
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
Use the \fBgit secret add\fR command to add filenames to this file\. It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\.
2016-02-23 21:48:25 +00:00
.
2018-08-26 17:26:15 +00:00
.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\.
.
2016-02-23 21:48:25 +00:00
.SH "OPTIONS"
.
.nf
2020-10-04 19:20:24 +00:00
\-v \- verbose, shows extra information\.
\-i \- does nothing, adding paths to \.gitignore is now the default behavior\.
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