Skip to content

Commit efb5318

Browse files
authored
Update README.md
1 parent 456daf9 commit efb5318

1 file changed

Lines changed: 30 additions & 31 deletions

File tree

README.md

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,36 @@ A handy utility to quickly encrypt/decrypt strings from terminal and files using
1010
## Arguments List
1111

1212
```
13-
----------------------------------REQUIRED ARGUMENTS--------------------------
14-
<encrypt/decrypt | encryptFile/decryptFile> Choose if you want to encrypt or decrypt data
15-
-b<AES | RSA> Choose between RSA and AES encryption
16-
\"content to encrypt goes here\"
17-
--------------------------OPTIONAL ARGUMENTS FOR AES--------------------------
18-
-s <128 | 192 | 256> specify the size of the key with one of the shown value.
19-
Default is 128.
20-
-fiv <FILELOCATION> specify the hexadecimal file where specified VI islocated
21-
-p <PASS:SALT> specify a password for encryption/decryption with the specified PASS and SALT
22-
-k <KEYFILELOCATION> specify location for setting a specific Base64 encoded key
23-
-a <CBS|CFB|OFB|CTR|GCM> choose alghorithm type
24-
Default is CBS
25-
-wiv <FILENAME> Creates a file with the latest VI used or the specified one if there is.
26-
-wk <FILENAME> Creates a file with the latest Key Encoded value used or the specified one if there is.
27-
-i <FILENAME> Input file encrypted/decrypted or physical file to encrypt/decrypt.
28-
-o <FILENAME> Output file to specify if you want to encrypt/decrypt an entire physical file or
29-
where you want to save encrypted/decrypted content.
30-
-v Set verbose to true (Use it only for encryptFile/decryptFile when files are big)
31-
Default is set to false
32-
---------------------------------OPTIONAL ARGUMENTS FOR RSA--------------------------
33-
-s <512|1024|2048|4096....|inf> Specify the key size, multiples of 2!!
34-
Default is set to 512
35-
You may need to specify -s option when encrypting/decrypting physical files
36-
-fkpr <FILENAME> Specify format private key with a PEM format from a file
37-
-fkpu <FILENAME> Specify format public key with a PEM format from a file
38-
-wkpr <FILENAME> Creates a file with the latest private key used in PEM format
39-
-wkpu <FILENAME> Creates a file with the latest public key used in PEM format
40-
-i <FILENAME> Input file encrypted/decrypted
41-
-o <FILENAME> Output file to specify if you want to encrypt/decrypt an entire file.
42-
-v Set verbose to true (Use it only for encryptFile/decryptFile when files are big)
43-
Default is set to false
13+
----------------------------------REQUIRED ARGUMENTS--------------------------
14+
<encrypt/decrypt | encryptFile/decryptFile> Choose if you want to encrypt or decrypt data
15+
-b<AES | RSA> Choose between RSA and AES encryption
16+
\"content to encrypt goes here\"
17+
--------------------------OPTIONAL ARGUMENTS FOR AES--------------------------
18+
-s <128 | 192 | 256> specify the size of the key with one of the shown value.
19+
Default is 128.
20+
-fiv <FILELOCATION> specify the hexadecimal file where specified VI islocated
21+
-p <PASS:SALT> specify a password for encryption/decryption with the specified PASS and SALT
22+
-k <KEYFILELOCATION> specify location for setting a specific Base64 encoded key
23+
-a <CBS|CFB|OFB|CTR|GCM> choose alghorithm type
24+
Default is CBS
25+
-wiv <FILENAME> Creates a file with the latest VI used or the specified one if there is.
26+
-wk <FILENAME> Creates a file with the latest Key Encoded value used or the specified one if there is.
27+
-i <FILENAME> Input file encrypted/decrypted or physical file to encrypt/decrypt.
28+
-o <FILENAME> Output file to specify if you want to encrypt/decrypt an entire physical file or
29+
where you want to save encrypted/decrypted content.
30+
-v Set verbose to true (Use it only for encryptFile/decryptFile when files are big)
31+
Default is set to false
32+
---------------------------------OPTIONAL ARGUMENTS FOR RSA--------------------------
33+
-s <512|1024|2048|4096....|inf> Specify the key size, multiples of 2!!
34+
Default is set to 512
35+
You may need to specify -s option when encrypting/decrypting physical files
36+
-fkpr <FILENAME> Specify format private key with a PEM format from a file
37+
-fkpu <FILENAME> Specify format public key with a PEM format from a file
38+
-wkpr <FILENAME> Creates a file with the latest private key used in PEM format
39+
-wkpu <FILENAME> Creates a file with the latest public key used in PEM format
40+
-i <FILENAME> Input file encrypted/decrypted
41+
-o <FILENAME> Output file to specify if you want to encrypt/decrypt an entire file.
42+
-v Set verbose to true (Use it only for encryptFile/decryptFile when files are big) Default is set to false
4443
```
4544
## Quick Use
4645

0 commit comments

Comments
 (0)