Skip to content

Commit 6273274

Browse files
committed
fix: 🐛 generate command help
1 parent cb73814 commit 6273274

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ pip install git+https://github.com/ZhaoQi99/pyencrypt-pye.git
2121
✨🍰✨
2222
```
2323
## Usage
24+
25+
```shell
26+
Usage: pyencrypt [OPTIONS] COMMAND [ARGS]...
27+
28+
Options:
29+
--version Show the version and exit.
30+
-h, --help Show this message and exit.
31+
32+
Commands:
33+
decrypt Decrypt encrypted pye file
34+
encrypt Encrypt your python code
35+
generate Generate loader file using specified key
36+
```
37+
2438
### Encrypt
2539
```shell
2640
~$ pyencrypt encrypt -h
@@ -46,6 +60,19 @@ Options:
4660
-k, --key TEXT Your encryption key. [required]
4761
-h, --help Show this message and exit.
4862
```
63+
### Generate
64+
65+
```shell
66+
~$ pyencrypt generate -h
67+
Usage: pyencrypt generate [OPTIONS]
68+
69+
Generate loader file using specified key
70+
71+
Options:
72+
-k, --key TEXT Your encryption key. [required]
73+
-h, --help Show this message and exit.
74+
```
75+
4976
## Example
5077
### Encrypt
5178
```shell

pyencrypt/cli.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
from pyencrypt.encrypt import (can_encrypt, encrypt_file, encrypt_key,
1111
generate_so_file)
1212
from pyencrypt.generate import generate_aes_key
13+
from pyencrypt.check import CheckFinder
14+
1315

1416
VERSION = f"""\
1517
_
@@ -153,6 +155,7 @@ def decrypt_command(pathname, key):
153155
required=True,
154156
help='Your encryption key.',
155157
type=click.STRING)
158+
@click.help_option('-h', '--help')
156159
@click.pass_context
157160
def generate_loader(ctx, key):
158161
"""Generate loader file using specified key"""

0 commit comments

Comments
 (0)