From 698c27ff3115b8abfda159cfc5a1ce692711204f Mon Sep 17 00:00:00 2001 From: Ariz Siddiqui Date: Wed, 13 Jan 2021 21:31:12 +0530 Subject: [PATCH 1/5] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47b04b7..38c788e 100644 --- a/README.md +++ b/README.md @@ -55,15 +55,47 @@ clik FILENAME add ```python clik FILENAME subtract ``` -## Modify Keys: +## For Modifying Keys: To modify any key in an existing JSON file, type the following command in your console: ```python clik FILENAME modify ``` +## For Encrypting the Keys File: +To encrypt the JSON file, type the following command in your console: +```python +clik FILENAME enc +``` +This will ask for any existing Keys to encrypt the JSON file with. If you have an existing Key, + continue. Else, you can specify/create a new key for this new encryption. + + ## For Decrypting the Keys File: + To decrypt the JSON file, type the following command in your console: + ```python + clik FILENAME dec + ``` +This will ask for any existing Keys to decrypt the JSON file with. If you have an existing Key, +continue normally. Else, provide a path for the Key to be used for decryption. + + ### Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first. + +## Help: +To check the syntax for any of the commands or their function, type the following command in your console: +```python +clik --help +``` + +## Version +To check the version of CLIK you're running, type the following command in your console: +```python +clik --version +``` + +### Note: Before uploading the JSON file containing your Keys to any VCS, it is recommended to store your .key file containing your Key to decrypt this encrypted JSON file in .gitignore of any other directory of your computer. ## Dependancies: * [printy](https://github.com/edraobdu/printy) * [Python 3](https://python.org/) +* [cryptography](https://github.com/pyca/cryptography) ## Contributors: * [Mihir Singh](https://github.com/mihirs16) From 9e7b83bda9be32070601c8d2a252879a9b1aafa1 Mon Sep 17 00:00:00 2001 From: Ariz Siddiqui <54595135+arizsiddiqui@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:35:29 +0530 Subject: [PATCH 2/5] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 38c788e..6d962da 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,7 @@ To check the version of CLIK you're running, type the following command in your ```python clik --version ``` - -### Note: Before uploading the JSON file containing your Keys to any VCS, it is recommended to store your .key file containing your Key to decrypt this encrypted JSON file in .gitignore of any other directory of your computer. +> Note: Before uploading the JSON file containing your Keys to any VCS, it is recommended to store your .key file containing your Key to decrypt this encrypted JSON file in .gitignore of any other directory of your computer. ## Dependancies: * [printy](https://github.com/edraobdu/printy) @@ -101,4 +100,4 @@ clik --version * [Mihir Singh](https://github.com/mihirs16) * [Anushka Agarwal](https://github.com/anushka17agarwal) * [Kushagra Gupta](https://github.com/KG-1510) -* [Ariz Siddiqui](https://github.com/arizsiddiqui) \ No newline at end of file +* [Ariz Siddiqui](https://github.com/arizsiddiqui) From fc9d5bc11cc1b7f919003a2722bcf44049617909 Mon Sep 17 00:00:00 2001 From: Ariz Siddiqui <54595135+arizsiddiqui@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:35:58 +0530 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d962da..f669297 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ This will ask for any existing Keys to encrypt the JSON file with. If you have a This will ask for any existing Keys to decrypt the JSON file with. If you have an existing Key, continue normally. Else, provide a path for the Key to be used for decryption. - ### Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first. +> Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first. ## Help: To check the syntax for any of the commands or their function, type the following command in your console: From 98e074cf4f106ba466c4d311cdd7899e36c97f69 Mon Sep 17 00:00:00 2001 From: Ariz Siddiqui <54595135+arizsiddiqui@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:37:19 +0530 Subject: [PATCH 4/5] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f669297..86e0b99 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,30 @@ CLIK provides you with a command line interface that allows you to store your AP You are provided with an option to either store this key locally in a file, or making a note of it to store it anyway you like. The encrypted JSON file can safely be uploaded to VCS repositories, meaning access will only be granted to those who have been given the JSON decryption key by you. You can use the CLIK to also add, remove or modify keys, as and when required. -## Built With: +## Built With | Software | Version | |----------|---------| | Python 3 | 3.7.1 | | Visual Studio Code| 1.50.1| -## Tested With: +## Tested With | Operating System | Version(s) | |----------|-------------| | Microsoft Windows | Windows 10 | | Apple macOS | 10.15(Catalina), Beta 11.0(Big Sur) | -## Installation: +## Installation You can either clone this repository or install it via pip ```python pip install clik ``` -## Usage: +## Usage Once you install CLIK, a short and concise documentation can be found br running the following command on your console: ```python clik ``` -## Initialising the JSON File: +## Initialising the JSON File To create a new file to store keys type the following command in your console: ```python clik init @@ -43,24 +43,24 @@ Now, you can specify all the keys you want to add in a step by step fashion. CLIK will automatically encrypt the file for you and generate your encryption key. Now you can either store the key locally or write it down for safekeeping. So now, your JSON file containing all your keys is ready for upload on your repository. -## Adding/Subtracting Keys: +## Adding/Subtracting Keys To add new keys to an existing JSON file, type the following command in your console:
-### For Adding Keys: +### For Adding Keys ```python clik FILENAME add ``` -### For Subtracting Keys: +### For Subtracting Keys ```python clik FILENAME subtract ``` -## For Modifying Keys: +## For Modifying Keys To modify any key in an existing JSON file, type the following command in your console: ```python clik FILENAME modify ``` -## For Encrypting the Keys File: +## For Encrypting the Keys File To encrypt the JSON file, type the following command in your console: ```python clik FILENAME enc @@ -68,7 +68,7 @@ clik FILENAME enc This will ask for any existing Keys to encrypt the JSON file with. If you have an existing Key, continue. Else, you can specify/create a new key for this new encryption. - ## For Decrypting the Keys File: + ## For Decrypting the Keys File To decrypt the JSON file, type the following command in your console: ```python clik FILENAME dec @@ -78,7 +78,7 @@ continue normally. Else, provide a path for the Key to be used for decryption. > Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first. -## Help: +## Help To check the syntax for any of the commands or their function, type the following command in your console: ```python clik --help From 78f32f023f551c7d80135ccabb0bd34b39577192 Mon Sep 17 00:00:00 2001 From: Ariz Siddiqui <54595135+arizsiddiqui@users.noreply.github.com> Date: Wed, 13 Jan 2021 21:37:53 +0530 Subject: [PATCH 5/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86e0b99..9e40057 100644 --- a/README.md +++ b/README.md @@ -91,12 +91,12 @@ clik --version ``` > Note: Before uploading the JSON file containing your Keys to any VCS, it is recommended to store your .key file containing your Key to decrypt this encrypted JSON file in .gitignore of any other directory of your computer. -## Dependancies: +## Dependancies * [printy](https://github.com/edraobdu/printy) * [Python 3](https://python.org/) * [cryptography](https://github.com/pyca/cryptography) -## Contributors: +## Contributors * [Mihir Singh](https://github.com/mihirs16) * [Anushka Agarwal](https://github.com/anushka17agarwal) * [Kushagra Gupta](https://github.com/KG-1510)