cli: add -h as shortcut to --help

m1stadev · Dec 27, 2023 · 16510e9 · 16510e9
1 parent 14e9c46
commit 16510e9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ Usage: pyimg4 [OPTIONS] COMMAND [ARGS]...
 
 Options:
   --version  Show the version and exit.
-  --help     Show this message and exit.
+  -h, --help     Show this message and exit.
 
 Commands:
   im4m  Image4 manifest commands.

diff --git a/pyimg4/__main__.py b/pyimg4/__main__.py
@@ -7,8 +7,10 @@
 import pyimg4
 from pyimg4 import Compression, Keybag
 
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
-@click.group()
+
+@click.group(context_settings=CONTEXT_SETTINGS)
 @click.version_option(message=f'PyIMG4 {pyimg4.__version__}')
 def cli():
     """A Python CLI tool for parsing Apple's Image4 format."""