Skip to content

Commit b4a4afc

Browse files
committed
Add tip about histignorespace in README
h/t @iangmaia in #10 (comment)
1 parent 0d569f0 commit b4a4afc

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,20 +141,24 @@ This will show the raw content as stored in the repository. So even if `cat my-s
141141
After you freshly clone a repository which contains files which have been encrypted by `git-conceal`, you need to provide the symmetric key that your coworkers would have shared with you to decrypt it:
142142

143143
```bash
144-
# Option 1: Provide the key via an environment variable (base64 encoded). Recommended on CI.
145-
export GIT_SECRETS_KEY="YOUR_BASE64_KEY"
146-
git-conceal unlock env:GIT_SECRETS_KEY
144+
# Option 1: Provide the key via an environment variable (base64 encoded).
145+
# Recommended on CI, where secret values like the key are usually exposed to jobs as env vars.
146+
$ git-conceal unlock env:GIT_CONCEAL_SECRET_KEY
147147

148-
# Option 2: Provide the Base64-encoded key as command line argument. (Only use locally, as on CI this could leak the key in logs).
149-
git-conceal unlock "base64:c3VwcG9zZWRseS15b3VyLWJpbmFyeS1zZWNyZXRrZXk="
148+
# Option 2: Provide the Base64-encoded key as command line argument.
149+
# Only use locally, as on CI this could leak the key in logs.
150+
# Tip: start your command with a space to avoid it (and thus the key) being added to your shell's history
151+
$ git-conceal unlock "base64:c3VwcG9zZWRseS15b3VyLWJpbmFyeS1zZWNyZXRrZXk="
150152

151153
# Option 3: Provide a path to a from file containing the raw binary, 32 bytes key.
152-
git-conceal unlock /path/to/key.bin
154+
$ git-conceal unlock /path/to/key.bin
153155

154156
# Option 4: Provide it via stdin (expects raw binary, 32 bytes as input)
155-
cat /path/to/key.bin | git-conceal unlock -
156-
# Or convert from base64. (Only use locally, as on CI this could leak the key in logs).
157-
echo "c3VwcG9zZWRseS15b3VyLWJpbmFyeS1zZWNyZXRrZXk=" | base64 -d | git-conceal unlock -
157+
$ cat /path/to/key.bin | git-conceal unlock -
158+
# Or convert from base64.
159+
# Only use locally, as on CI this could leak the key in logs.
160+
# Tip: start your command with a space to avoid it (and thus the key) being added to your shell's history
161+
$ echo "c3VwcG9zZWRseS15b3VyLWJpbmFyeS1zZWNyZXRrZXk=" | base64 -d | git-conceal unlock -
158162
```
159163

160164
This will:

0 commit comments

Comments
 (0)