diff --git a/README.md b/README.md new file mode 100644 index 0000000..72c0535 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ + +# qGPG + +Slightly easier encryption using private/public key pairs + +Depends on python-gnupg, and gpg + +Install with pip or pipx, from packaged url, or straight from repository: + +- https://six9.net/py/qgpg/current.tar.gz +- git+https://bitbucket.org/MoonQ/qgpg + +Usage +===== + +- Generate keys: + - `qgpg --keygen --key ./path/mykey --name "user@name"` + - This will create private and public keys, mykey and mykey.pub + - Share the public key to someone who will encrypt data to you +- Encrypt file: + - `qgpg --encrypt --key ./mykey.pub ./plain_file.txt ./encrypted_file.txt.gpg` +- Encrypt all files recursively in a folder: + - `qgpg --key ./mykey.pub -r --encrypt ./in_folder/` + - `qgpg --key ./mykey.pub -r --encrypt ./from_folder/ ./to_another_folder/` +- Decrypt all files with the private key: + - `qgpg --key ./mykey -r --decrypt ./encrypted_folder/` +- Using passhprase in a variable: + - `GPGPASS=mysecretpassword qgpg --key ./mykey --decrypt file.gpg file.txt` +- Symmetric encryption: + - `GPGPASS=mysecretpassword qgpg --encrypt file.txt file.gpg` + + +