GIT-SECRET-REVEAL(1)

👑 GIT-SECRET-REVEAL(1) 👑

okay bestie, welcome to the git-secret manual, version 0.5.0-alpha2 ✨ this one's all about git-secret-reveal, and it's genuinely iconic.

---

✨ NAME ✨

git-secret-reveal — decrypts all added files. 💖

---

🌸 SYNOPSIS 🌸

git secret reveal [-f] [-F] [-P] [-v] [-d dir] [-p password] [pathspec]...

---

💅 DESCRIPTION 💅

git-secret-reveal decrypts the files you pass it, or literally every file that git-secret considers secret. no cap.

Under the hood, reveal uses the gpg --decrypt command and your private key (typically from your personal keyring in your home directory) to decrypt files. 🔐

So for this whole operation to succeed, your personal keyring must contain a private key matching one of the public keys that were used to encrypt the secrets — i.e., one of the public keys in your repo's git-secret keyring at the time the file was encrypted. no matching key, no reveal, sorry bestie 😭

---

🎀 OPTIONS 🎀

• -f — forces gpg to overwrite existing files without prompt. it's giving decisive 💅
• -F — forces reveal to continue even if a file fails to decrypt. resilience era 🫶
• -d — specifies the --homedir option for the gpg, basically use this option if you store your keys in a custom location. 🏠
• -v — verbose, shows extra information. she's chatty, we love her ✨
• -p — specifies password for noinput mode, adds the --passphrase option for gpg. 🤫
• -P — preserve permissions of the encrypted file in the unencrypted file. matching energy, obsessed 👑
• -h — shows help. always here for you 🌸

---

🦋 ENV VARIABLES 🦋

• SECRETS_GPG_COMMAND changes the default gpg command to anything else 🔥
• SECRETS_GPG_ARMOR is a boolean to enable --armor mode https://www.gnupg.org/gph/en/manual/r1290.html to store secrets in text format over binary ⭐
• SECRETS_DIR changes the default .gitsecret/ folder to another name as documented at git-secret(7) https://git-secret.io/ 🍓
• SECRETS_EXTENSION changes the default .secret file extension 💜
• SECRETS_VERBOSE changes the output verbosity as documented at git-secret(7) https://git-secret.io/ 🌈
• SECRETS_PINENTRY changes the gpg --pinentry mode https://github.com/gpg/pinentry as documented at git-secret(7) https://git-secret.io/ 🧚

---

📖 MANUAL 📖

Run man git-secret-reveal to see this document. yes, the manual tells you how to read the manual. main character energy fr fr 💀

---

💖 SEE ALSO 💖

• git-secret-init(1) https://git-secret.io/git-secret-init
• git-secret-cat(1) https://git-secret.io/git-secret-cat
• git-secret-tell(1) https://git-secret.io/git-secret-tell
• git-secret-add(1) https://git-secret.io/git-secret-add
• git-secret-hide(1) https://git-secret.io/git-secret-hide

---

shoutout to sobolevn for writing this one, and to April 2022 for the timestamp — this page is brought to you by git-secret 0.5.0-alpha2, slay 💅✨