2016-02-21 13:26:17 +00:00
git-secret-reveal - decrypts all added files.
=============================================
## SYNOPSIS
2019-03-25 15:37:24 +00:00
git secret reveal [-f] [-F] [-P] [-v] [-d dir] [-p password] [pathspec]...
2016-02-21 13:26:17 +00:00
## DESCRIPTION
2022-04-17 19:17:07 +00:00
`git-secret-reveal` - decrypts passed files, or all files considered secret by `git-secret` .
2022-04-14 23:07:52 +00:00
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.
Therefore, for this operation to succeed, your personal keyring must contain a private key
matching one of the public keys which were used to encrypt the secrets --
2022-04-17 19:17:07 +00:00
i.e., one of the public keys in your repo's `git-secret` keyring when the file was encrypted.
2022-04-14 23:07:52 +00:00
2016-02-21 13:26:17 +00:00
## OPTIONS
2018-10-11 01:21:58 +00:00
-f - forces gpg to overwrite existing files without prompt.
-F - forces reveal to continue even if a file fails to decrypt.
2018-04-14 20:07:12 +00:00
-d - specifies `--homedir` option for the `gpg` , basically use this option if you store your keys in a custom location.
2019-03-25 15:37:24 +00:00
-v - verbose, shows extra information.
2016-02-21 13:26:17 +00:00
-p - specifies password for noinput mode, adds `--passphrase` option for `gpg` .
2018-08-18 14:09:58 +00:00
-P - preserve permissions of encrypted file in unencrypted file.
2016-02-21 13:26:17 +00:00
-h - shows help.
2021-06-26 13:24:26 +00:00
## 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
2021-06-26 14:17:37 +00:00
- `SECRETS_DIR` changes the default `.gitsecret/` folder to another name as documented at [git-secret(7) ](https://git-secret.io/ )
2021-06-26 13:24:26 +00:00
- `SECRETS_EXTENSION` changes the default `.secret` file extension
2021-06-26 14:17:37 +00:00
- `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/ )
2019-08-16 20:53:57 +00:00
2016-02-21 13:26:17 +00:00
Version 0.2.2 pre-release
There are a lot of changes, multiple things were refactored: tests,
some commands, building and meta.
Several critical bugs fixed.
Changes:
1. Fixed #74, when `_user_required` was not working after reimporting keys
2. Closes #73, now it is possible to provide multiple emails to the `killperson` command
3. Closes #72, now it is possible to provide multiple emails to the `tell` command
4. Closes #71, now every doc in this project refer to `git-secret.io` instead of old `gh-pages` website
5. Closes #70, now installation section is removed from main `man` file
6. Closes #69, now "See also" section in the `man`s are clickable
7. Closes #61, added "Manual" section to the manuals
8. Refs #38, added `centos` Dockerfile, but `ci` testing is still failing
9. Refs #52, tests are refactored. Added `clean` command tests, removed a lot of hardcoded things, moved tests execution from `./temp` folder to `/tmp`, added a lot of new check in old tests, and some new test cases
10. Refactored `hide` and `clean` commands to be shorter
11. `shellcheck` is now supported with `make lint`
Additional features are not comming to 0.2.2 after this commit.
2017-02-26 13:38:46 +00:00
## MANUAL
2022-04-14 23:07:52 +00:00
Run `man git-secret-reveal` to see this document.
Version 0.2.2 pre-release
There are a lot of changes, multiple things were refactored: tests,
some commands, building and meta.
Several critical bugs fixed.
Changes:
1. Fixed #74, when `_user_required` was not working after reimporting keys
2. Closes #73, now it is possible to provide multiple emails to the `killperson` command
3. Closes #72, now it is possible to provide multiple emails to the `tell` command
4. Closes #71, now every doc in this project refer to `git-secret.io` instead of old `gh-pages` website
5. Closes #70, now installation section is removed from main `man` file
6. Closes #69, now "See also" section in the `man`s are clickable
7. Closes #61, added "Manual" section to the manuals
8. Refs #38, added `centos` Dockerfile, but `ci` testing is still failing
9. Refs #52, tests are refactored. Added `clean` command tests, removed a lot of hardcoded things, moved tests execution from `./temp` folder to `/tmp`, added a lot of new check in old tests, and some new test cases
10. Refactored `hide` and `clean` commands to be shorter
11. `shellcheck` is now supported with `make lint`
Additional features are not comming to 0.2.2 after this commit.
2017-02-26 13:38:46 +00:00
2016-02-21 13:26:17 +00:00
## SEE ALSO
2021-06-26 14:17:37 +00:00
[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 )