Updated examples/cli/README.md for directory encryption/decryption docs #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Veinar
requested changes
Nov 24, 2024
examples/cli/README.md
Outdated
| envcloak encrypt --directory yourDirectory --output yourDirectory.enc --key-file mykey.key | ||
| ``` | ||
|
|
||
| **Description:** Encrypts your `yourDirectory` file into `yourDirectory.enc`. The original file remains unchanged. |
There was a problem hiding this comment.
Almost, but not quite 😀 it indeed encrypts directory and creates output directory (raises error if output directory exists, that's why --force flag is implemented). But EnvCloak processes files one by one in input directory and creates encrypted files in output directory. 😉
examples/cli/README.md
Outdated
| envcloak decrypt --directory yourDirectory.enc --output yourDirectory --key-file mykey.key | ||
| ``` | ||
|
|
||
| **Description:** Decrypts `yourDirectory.enc` back to `yourDirectory`. Ensure the `key-file` used matches the one from the encryption step. |
|
Hi @SethLK, 👋 Thanks for contribution, great work 🙌, but please make changes requested and we'll be ready to go. 😉 |
Veinar
approved these changes
Nov 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.