mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-10 13:10:46 +00:00
23acae1265
* use gpg --armor when hiding/encrypting files * update changelog * Adds SECRETS_GPG_ARMOR env variable * Fixes lint * One more test * Addresses review Co-authored-by: sobolevn <mail@sobolevn.me>
61 lines
2.4 KiB
Groff
61 lines
2.4 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "GIT\-SECRET\-REVEAL" "1" "June 2021" "sobolevn" "git-secret 0.5.0-alpha1"
|
|
.
|
|
.SH "NAME"
|
|
\fBgit\-secret\-reveal\fR \- decrypts all added files\.
|
|
.
|
|
.SH "SYNOPSIS"
|
|
.
|
|
.nf
|
|
|
|
git secret reveal [\-f] [\-F] [\-P] [\-v] [\-d dir] [\-p password] [pathspec]\.\.\.
|
|
.
|
|
.fi
|
|
.
|
|
.SH "DESCRIPTION"
|
|
\fBgit\-secret\-reveal\fR \- decrypts all the files in \fB\.gitsecret/paths/mapping\.cfg\fR, or the passed \fBpathspec\fRs\. You will need to have imported the paired secret\-key with one of the public\-keys which were used in the encryption\. Under the hood, this uses the \fBgpg \-\-decrypt\fR command\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.nf
|
|
|
|
\-f \- forces gpg to overwrite existing files without prompt\.
|
|
\-F \- forces reveal to continue even if a file fails to decrypt\.
|
|
\-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if you store your keys in a custom location\.
|
|
\-v \- verbose, shows extra information\.
|
|
\-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\.
|
|
\-P \- preserve permissions of encrypted file in unencrypted file\.
|
|
\-h \- shows help\.
|
|
.
|
|
.fi
|
|
.
|
|
.SH "ENV VARIABLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_GPG_COMMAND\fR changes the default \fBgpg\fR command to anything else
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_GPG_ARMOR\fR is a boolean to enable \fB\-\-armor\fR mode \fIhttps://www\.gnupg\.org/gph/en/manual/r1290\.html\fR to store secrets in text format over binary
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_DIR\fR changes the default \fB\.gitsecret/\fR folder to another name as documented at git\-secret(7) \fIhttp://git\-secret\.io/\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_EXTENSION\fR changes the default \fB\.secret\fR file extension
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_VERBOSE\fR changes the output verbosity as documented at git\-secret(7) \fIhttp://git\-secret\.io/\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBSECRETS_PINENTRY\fR changes the \fBgpg \-\-pinentry\fR mode \fIhttps://github\.com/gpg/pinentry\fR as documented at git\-secret(7) \fIhttp://git\-secret\.io/\fR
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "MANUAL"
|
|
Run \fBman git\-secret\-reveal\fR to see this note\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
git\-secret\-init(1) \fIhttp://git\-secret\.io/git\-secret\-init\fR, git\-secret\-cat(1) \fIhttp://git\-secret\.io/git\-secret\-cat\fR, git\-secret\-tell(1) \fIhttp://git\-secret\.io/git\-secret\-tell\fR, git\-secret\-add(1) \fIhttp://git\-secret\.io/git\-secret\-add\fR, git\-secret\-hide(1) \fIhttp://git\-secret\.io/git\-secret\-hide\fR
|