feat: Added -h flag for the --help menu unless overridden

Author: marcusfrdk

.gitignore

@@ -1,6 +1,6 @@
 # Other
 .DS_Store
-/test.py
+/test*.py
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -12,17 +12,28 @@
 
 A powerful extension for [Click](https://click.palletsprojects.com/) that adds **command and group aliasing** support with **automatic async function handling** and **advanced parameter validation**.
 
+You can find the project on [PyPi](https://pypi.org/project/click-with-aliasing/).
+
 ## Features
 
 - **Command Aliases**: Create multiple names for your commands
 - **Group Aliases**: Add aliases to command groups
+- **Help Alias (-h)**: Automatic `-h` shorthand for `--help` with conflict detection
 - **Enhanced Options & Arguments**: Mutual exclusivity, requirements, and group constraints
 - **Validation Rules**: Group-level validation with multiple modes (all_or_none, at_least, at_most, exactly)
 - **Automatic Async Support**: Seamlessly handle async functions without extra configuration
 - **Drop-in Replacement**: Works exactly like standard Click decorators
 - **Type Safe**: Full type hints support with proper IDE integration
 - **Help Integration**: Aliases automatically appear in help text
 
+## Installation
+
+```bash
+pip install click-with-aliasing
+```
+
+**Requirements:** Python 3.10 or newer
+
 ## Documentation
 
 - **[Command](docs/COMMAND.md)** - Command decorator with aliasing support
@@ -31,13 +42,7 @@ A powerful extension for [Click](https://click.palletsprojects.com/) that adds *
 - **[Argument](docs/ARGUMENT.md)** - Enhanced arguments with validation constraints
 - **[Rule](docs/RULE.md)** - Group-level validation rules for complex parameter logic
 
-## Installation
-
-```bash
-pip install click-with-aliasing
-```
-
-**Requirements:** Python 3.10 or newer
+> **Note:** Both `-h` and `--help` flags are supported by default. See the [Command](docs/COMMAND.md) and [Group](docs/GROUP.md) documentation for details on how `-h` is intelligently handled when commands use it for other purposes.
 
 ## Quick Start
 
@@ -134,7 +139,7 @@ Usage:
 my-cli deploy --production                          # Valid
 my-cli deploy --staging                             # Valid
 my-cli deploy --production --staging                # Error: exactly 1 required
-my-cli deploy                                        # Error: exactly 1 required
+my-cli deploy                                       # Error: exactly 1 required
 ```
 
 ## Async Support
@@ -260,7 +265,7 @@ All standard Click features work exactly the same, with optional enhancements av
 
 ## Help Text Integration
 
-Aliases automatically appear in help text:
+Aliases automatically appear in help text, and both `-h` and `--help` work for displaying help:
 
 ```txt
 myapp database --help
@@ -269,13 +274,15 @@ Usage: myapp database [OPTIONS] COMMAND [ARGS]...
   Database management commands
 
 Options:
-  --help  Show this message and exit.
+  -h, --help  Show this message and exit.
 
 Commands:
   migrate (m, mig)  Run database migrations
   seed (s)          Seed the database
 ```
 
+The `-h` flag is automatically added unless a command uses it for another purpose (like `--host`), ensuring consistent help access while avoiding conflicts.
+
 ## Contributing
 
 Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our development process, coding standards, and how to submit pull requests.

click_with_aliasing/command.py

@@ -23,6 +23,64 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.aliases: list[str] = kwargs.pop("aliases", [])
         super().__init__(*args, **kwargs)
 
+    def get_help_option(self, ctx: click.Context) -> click.Option | None:
+        """
+        Get the help option with -h alias support.
+
+        This method adds -h as an alias for --help unless the command
+        uses -h for another purpose.
+
+        Args:
+            ctx (click.Context):
+                The Click context.
+
+        Returns:
+            click.Option | None:
+                The help option with -h alias, or None if help is disabled.
+        """
+        help_option_names = self.get_help_option_names(ctx)
+        if not help_option_names:
+            return None
+
+        # Check if this command uses -h for another purpose
+        has_h_conflict = False
+        for param in self.params:
+            if hasattr(param, "opts") and "-h" in param.opts:
+                has_h_conflict = True
+                break
+
+        # Add -h to help option names if no conflict
+        if not has_h_conflict and "-h" not in help_option_names:
+            help_option_names = ["-h"] + list(help_option_names)
+
+        return click.Option(
+            help_option_names,
+            is_flag=True,
+            is_eager=True,
+            expose_value=False,
+            callback=self._show_help_callback,
+            help="Show this message and exit.",
+        )
+
+    @staticmethod
+    def _show_help_callback(
+        ctx: click.Context, param: click.Parameter, value: bool
+    ) -> None:
+        """
+        Callback to show help message.
+
+        Args:
+            ctx (click.Context):
+                The Click context.
+            param (click.Parameter):
+                The parameter that triggered the callback.
+            value (bool):
+                The value of the parameter.
+        """
+        if value and not ctx.resilient_parsing:
+            click.echo(ctx.get_help(), color=ctx.color)
+            ctx.exit()
+
 
 def command(
     name: str,

click_with_aliasing/group.py

@@ -23,6 +23,72 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.aliases: list[str] = kwargs.pop("aliases", [])
         super().__init__(*args, **kwargs)
 
+    def get_help_option(self, ctx: click.Context) -> click.Option | None:
+        """
+        Get the help option with -h alias support.
+
+        This method adds -h as an alias for --help unless the group itself or
+        any command in the group uses -h for another purpose.
+
+        Args:
+            ctx (click.Context):
+                The Click context.
+
+        Returns:
+            click.Option | None:
+                The help option with -h alias, or None if help is disabled.
+        """
+        help_option_names = self.get_help_option_names(ctx)
+        if not help_option_names:
+            return None
+
+        has_h_conflict = False
+        for param in self.params:
+            if hasattr(param, "opts") and "-h" in param.opts:
+                has_h_conflict = True
+                break
+
+        if not has_h_conflict:
+            for cmd_name, cmd in self.commands.items():
+                if cmd_name == cmd.name:
+                    for param in getattr(cmd, "params", []):
+                        if hasattr(param, "opts") and "-h" in param.opts:
+                            has_h_conflict = True
+                            break
+                if has_h_conflict:
+                    break
+
+        if not has_h_conflict and "-h" not in help_option_names:
+            help_option_names = ["-h"] + list(help_option_names)
+
+        return click.Option(
+            help_option_names,
+            is_flag=True,
+            is_eager=True,
+            expose_value=False,
+            callback=self._show_help_callback,
+            help="Show this message and exit.",
+        )
+
+    @staticmethod
+    def _show_help_callback(
+        ctx: click.Context, param: click.Parameter, value: bool
+    ) -> None:
+        """
+        Callback to show help message.
+
+        Args:
+            ctx (click.Context):
+                The Click context.
+            param (click.Parameter):
+                The parameter that triggered the callback.
+            value (bool):
+                The value of the parameter.
+        """
+        if value and not ctx.resilient_parsing:
+            click.echo(ctx.get_help(), color=ctx.color)
+            ctx.exit()
+
     def add_command(self, cmd: click.Command, name: str | None = None) -> None:
         """
         Add a command to the group, including its aliases.

docs/COMMAND.md

@@ -34,9 +34,9 @@ def deploy():
 All of these work:
 
 ```bash
-$ python app.py deploy
-$ python app.py d
-$ python app.py dep
+python app.py deploy
+python app.py d
+python app.py dep
 ```
 
 ## With Parameters
@@ -179,6 +179,57 @@ Commands:
   deploy (d, dep)  Deploy the application to production
 ```
 
+### Help Flag (-h)
+
+By default, commands support both `-h` and `--help` for displaying help:
+
+```python
+from click_with_aliasing import command
+
+@command("process")
+def process():
+    """Process data"""
+    print("Processing...")
+```
+
+```bash
+$ python app.py process -h
+Usage: app.py process [OPTIONS]
+
+  Process data
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
+However, if a command uses `-h` for another option, it will not have `-h` as a help alias:
+
+```python
+from click_with_aliasing import command, option
+
+@command("connect")
+@option("--host", "-h", help="Server hostname")
+def connect(host):
+    """Connect to a server"""
+    print(f"Connecting to {host}")
+```
+
+```bash
+# -h is used for --host option
+$ python app.py connect -h localhost
+Connecting to localhost
+
+# Help is available via --help only
+$ python app.py connect --help
+Usage: app.py connect [OPTIONS]
+
+  Connect to a server
+
+Options:
+  -h, --host TEXT  Server hostname
+  --help           Show this message and exit.
+```
+
 ## API Reference
 
 ```python

docs/GROUP.md

@@ -273,6 +273,63 @@ Commands:
   seed (s)          Seed the database
 ```
 
+### Help Flag (-h)
+
+By default, groups support both `-h` and `--help` for displaying help:
+
+```python
+from click_with_aliasing import group
+
+@group()
+def cli():
+    """My CLI application"""
+    pass
+```
+
+```bash
+$ python app.py -h
+Usage: app.py [OPTIONS] COMMAND [ARGS]...
+
+  My CLI application
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
+However, if any command in the group uses `-h` for another purpose, the group will only show `--help`:
+
+```python
+from click_with_aliasing import group, command, option
+
+@group()
+def cli():
+    """Network tools"""
+    pass
+
+@command("ping")
+@option("--host", "-h", required=True, help="Target host")
+def ping(host):
+    """Ping a host"""
+    print(f"Pinging {host}")
+
+cli.add_command(ping)
+```
+
+```bash
+# Group only has --help (not -h) because ping command uses -h
+$ python app.py --help
+Usage: app.py [OPTIONS] COMMAND [ARGS]...
+
+  Network tools
+
+Options:
+  --help  Show this message and exit.
+
+# The ping command uses -h for --host
+$ python app.py ping -h localhost
+Pinging localhost
+```
+
 ## API Reference
 
 ```python

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "click_with_aliasing"
-version = "1.2.0"
+version = "1.2.1"
 description = "A library that allows you to add aliases to your Click group and commands."
 authors = [
     { name = "Marcus Fredriksson", email = "marcus@marcusfredriksson.com" },