|
1 | 1 | # PGP-generate (pgpg) |
2 | 2 |
|
3 | | -Simple CLI tool to generate PGP keys pair. |
| 3 | +A simple CLI tool for generating PGP key pairs. |
4 | 4 |
|
5 | 5 | ## Installation |
6 | 6 |
|
7 | | -`npm i -g pgp-generate` |
| 7 | +Install globally using npm: |
| 8 | + |
| 9 | +```sh |
| 10 | +npm install -g pgp-generate |
| 11 | +``` |
8 | 12 |
|
9 | 13 | ## Usage |
10 | 14 |
|
11 | | -Run for details: |
12 | | -```shell |
| 15 | +### Display Help |
| 16 | + |
| 17 | +To see all available commands and options, run: |
| 18 | + |
| 19 | +```sh |
13 | 20 | pgpg --help |
14 | 21 | ``` |
15 | 22 |
|
16 | | -Generate key to files {fileName}.private and {fileName}.public: |
17 | | -```shell |
18 | | -pgpg -n {name} -e {email} -p {secret phrase} -f {path to file} |
| 23 | +### Generate a PGP Key Pair to Files |
| 24 | + |
| 25 | +Generate a PGP key pair and save it as `{fileName}.private` and `{fileName}.public`: |
| 26 | + |
| 27 | +```sh |
| 28 | +pgpg -n <name> -e <email> -p <secret phrase> -f <path to file> |
19 | 29 | ``` |
20 | 30 |
|
21 | | -Generate key to console: |
22 | | -```shell |
23 | | -pgpg -n {name} -e {email} -p {secret phrase} --print |
| 31 | +### Generate a PGP Key Pair to Console |
| 32 | + |
| 33 | +Generate a PGP key pair and print it directly to the console: |
| 34 | + |
| 35 | +```sh |
| 36 | +pgpg -n <name> -e <email> -p <secret phrase> --print |
24 | 37 | ``` |
25 | 38 |
|
26 | | -Additional parameters: |
| 39 | +### Additional Options |
| 40 | + |
| 41 | +- `-l, --level`: Sets the key security level (0, 1, 2, 3). |
| 42 | + - Default: **3** (generates a `4096-bit` key for maximum security). |
| 43 | + |
| 44 | +## Contributing |
| 45 | + |
| 46 | +Contributions are welcome! Feel free to fork, modify, and submit a pull request. |
27 | 47 |
|
28 | | -`-l, --level`: key security level (0, 1, 2, 3), default is **3** (key with `4096` length will be generated) |
| 48 | +For issues or feature requests, please open an issue. |
29 | 49 |
|
30 | | -## Contribution |
| 50 | +--- |
31 | 51 |
|
32 | | -Feel free to copy and use this version. Let me know if you need any further modifications! |
| 52 | +This version makes the content clearer, improves readability, and adds professionalism. Let me know if you'd like any |
| 53 | +tweaks! 🚀 |
0 commit comments