hexastack-cli 0.9.0__tar.gz → 0.10.0__tar.gz

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexastack-cli
-Version: 0.9.0
+Version: 0.10.0
 Summary: Hexastack CLI presentation adapter with Typer and Rich
 Author: Richard West
 Author-email: Richard West <dopplereffect.us@gmail.com>

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.9.0"
+version = "0.10.0"
 description = "Hexastack CLI presentation adapter with Typer and Rich"
 readme = "README.md"
 license = "Apache-2.0"
@@ -24,7 +24,7 @@ testing = ["playwright>=1.49.0"]
 cli = "hexastack_cli.infra.bootstrap:CliBootstrapper"
 
 [build-system]
-requires = ["uv_build>=0.12.3,<0.13.0"]
+requires = ["uv_build>=0.12.3,<0.14.0"]
 build-backend = "uv_build"
 
 [tool.uv.sources.hexastack-core]

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.9.0"
+version = "0.10.0"
 description = "Hexastack CLI presentation adapter with Typer and Rich"
 readme = "README.md"
 license = "Apache-2.0"
@@ -25,7 +25,7 @@ testing = [
 cli = "hexastack_cli.infra.bootstrap:CliBootstrapper"
 
 [build-system]
-requires = ["uv_build>=0.12.3,<0.13.0"]
+requires = ["uv_build>=0.12.3,<0.14.0"]
 build-backend = "uv_build"
 
 [tool.uv.sources]

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/src/hexastack_cli/adapters/routing.py

@@ -307,6 +307,7 @@ def register_cqrs_command(
     presenter: RichTerminalPresenter | None = None,
     console: Console | None = None,
     feature_flag: str | None = None,
+    hidden: bool = False,
 ) -> None:
     """Register a CQRS Command model as a typed CLI sub-command on a Typer application.
 
@@ -325,6 +326,7 @@ def register_cqrs_command(
         presenter: Optional RichTerminalPresenter instance.
         console: Optional rich Console instance.
         feature_flag: Optional feature flag key required for execution.
+        hidden: Whether to hide the command from CLI help documentation.
 
     Returns:
         None.
@@ -343,7 +345,7 @@ def register_cqrs_command(
         console=console,
         feature_flag=feature_flag,
     )
-    app.command(name=cmd_name, help=doc)(runner)
+    app.command(name=cmd_name, help=doc, hidden=hidden)(runner)
 
 
 def register_cqrs_query(
@@ -357,6 +359,7 @@ def register_cqrs_query(
     presenter: RichTerminalPresenter | None = None,
     console: Console | None = None,
     feature_flag: str | None = None,
+    hidden: bool = False,
 ) -> None:
     """Register a CQRS Query model as a typed CLI sub-command on a Typer application.
 
@@ -375,6 +378,7 @@ def register_cqrs_query(
         presenter: Optional RichTerminalPresenter instance.
         console: Optional rich Console instance.
         feature_flag: Optional feature flag key required for execution.
+        hidden: Whether to hide the command from CLI help documentation.
 
     Returns:
         None.
@@ -393,4 +397,4 @@ def register_cqrs_query(
         console=console,
         feature_flag=feature_flag,
     )
-    app.command(name=qry_name, help=doc)(runner)
+    app.command(name=qry_name, help=doc, hidden=hidden)(runner)

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/src/hexastack_cli/infra/autodiscovery.py

@@ -92,6 +92,7 @@ def _register_model_target(
     meta: CliMetadata,
     cmd_name: str,
     help_text: str | None,
+    hidden: bool,
     pipeline: ExecutionPipeline,
     console: Console | None,
 ) -> None:
@@ -107,6 +108,7 @@ def _register_model_target(
             output_format=meta.output_format,
             console=console,
             feature_flag=meta.feature_flag,
+            hidden=hidden,
         )
     elif meta.kind == "query" and issubclass(obj, Query):
         register_cqrs_query(
@@ -119,9 +121,29 @@ def _register_model_target(
             output_format=meta.output_format,
             console=console,
             feature_flag=meta.feature_flag,
+            hidden=hidden,
         )
 
 
+def _resolve_alias_targets(
+    group: str | Sequence[str] | None,
+    aliases: Sequence[str],
+    help_text: str | None,
+) -> list[tuple[list[str], str, str | None]]:
+    """Resolve (group_parts, cmd_name, help) targets for a sequence of aliases."""
+    primary_group = _normalize_group_path(group)
+    targets: list[tuple[list[str], str, str | None]] = []
+    for alias in aliases:
+        if alias.startswith("/"):
+            targets.append(([], alias.lstrip("/"), help_text))
+        elif any(sep in alias for sep in (".", "/", " ")):
+            parts = _normalize_group_path(alias)
+            targets.append((parts[:-1], parts[-1], help_text))
+        else:
+            targets.append((primary_group, alias, help_text))
+    return targets
+
+
 def _resolve_targets(
     meta: CliMetadata, default_name: str
 ) -> list[tuple[list[str], str, str | None]]:
@@ -131,16 +153,7 @@ def _resolve_targets(
     targets: list[tuple[list[str], str, str | None]] = [
         (primary_group, primary_name, meta.help)
     ]
-
-    for alias in meta.aliases:
-        if alias.startswith("/"):
-            targets.append(([], alias.lstrip("/"), meta.help))
-        elif any(sep in alias for sep in (".", "/", " ")):
-            parts = _normalize_group_path(alias)
-            targets.append((parts[:-1], parts[-1], meta.help))
-        else:
-            targets.append((primary_group, alias, meta.help))
-
+    targets.extend(_resolve_alias_targets(meta.group, meta.aliases, meta.help))
     return targets
 
 
@@ -205,11 +218,22 @@ def create_cli_visitor(
 
         default_name = _to_kebab_case(obj.__name__)
         targets = _resolve_targets(meta, default_name)
+        hidden = getattr(meta, "hidden", False)
 
         for group_parts, cmd_name, help_text in targets:
             target_app = manager.get_or_create(group_parts)
             _register_model_target(
-                target_app, obj, meta, cmd_name, help_text, pipeline, console
+                target_app, obj, meta, cmd_name, help_text, hidden, pipeline, console
+            )
+
+        if meta.hidden_aliases:
+            hidden_targets = _resolve_alias_targets(
+                meta.group, meta.hidden_aliases, meta.help
             )
+            for group_parts, cmd_name, help_text in hidden_targets:
+                target_app = manager.get_or_create(group_parts)
+                _register_model_target(
+                    target_app, obj, meta, cmd_name, help_text, True, pipeline, console
+                )
 
     return visitor

{hexastack_cli-0.9.0 → hexastack_cli-0.10.0}/src/hexastack_cli/infra/decorators.py

@@ -1,5 +1,6 @@
 from collections.abc import Callable, Sequence
 from dataclasses import dataclass, field
+from functools import wraps
 from typing import Any, Literal, TypeVar
 
 from hexastack_core.domain import Command, Query
@@ -28,6 +29,8 @@ class CliMetadata:
     output_format: str | None = None
     group: str | Sequence[str] | None = None
     feature_flag: str | None = None
+    hidden: bool = False
+    hidden_aliases: tuple[str, ...] = field(default_factory=tuple)
 
 
 @dataclass(frozen=True)
@@ -66,10 +69,12 @@ def cli_command(
     *,
     positional: Sequence[str] | str | None = None,
     aliases: Sequence[str] | str | None = None,
+    hidden_aliases: Sequence[str] | str | None = None,
     help: str | None = None,
     output_format: str | None = None,
     group: str | Sequence[str] | None = None,
     feature_flag: str | None = None,
+    hidden: bool = False,
 ) -> Callable[[type[TCommand]], type[TCommand]]:
     """Decorator marking a Command class for automatic CLI command exposure.
 
@@ -77,10 +82,12 @@ def cli_command(
         name: Optional custom CLI command name (defaults to kebab-cased class name).
         positional: Optional field name or list of field names to treat as positional CLI arguments.
         aliases: Optional alias or list of aliases (can be intra-group like 'create' or cross-group like 'account.new').
+        hidden_aliases: Optional alias or list of aliases to register with hidden=True.
         help: Optional help text for the command.
         output_format: Optional presenter output format.
         group: Optional sub-command group name or nested group path (e.g. 'user', 'user.profile').
         feature_flag: Optional feature flag key required to execute the command.
+        hidden: Whether to hide the command from terminal --help displays.
 
     Returns:
         Decorated Command class with attached CLI metadata.
@@ -95,10 +102,12 @@ def cli_command(
             name=name,
             positional=_normalize_tokens(positional),
             aliases=_normalize_tokens(aliases),
+            hidden_aliases=_normalize_tokens(hidden_aliases),
             help=help,
             output_format=output_format,
             group=group,
             feature_flag=feature_flag,
+            hidden=hidden,
         )
         setattr(cls, _CLI_METADATA_ATTR, meta)
         return cls
@@ -137,10 +146,12 @@ def cli_query(
     *,
     positional: Sequence[str] | str | None = None,
     aliases: Sequence[str] | str | None = None,
+    hidden_aliases: Sequence[str] | str | None = None,
     help: str | None = None,
     output_format: str | None = None,
     group: str | Sequence[str] | None = None,
     feature_flag: str | None = None,
+    hidden: bool = False,
 ) -> Callable[[type[TQuery]], type[TQuery]]:
     """Decorator marking a Query class for automatic CLI command exposure.
 
@@ -148,10 +159,12 @@ def cli_query(
         name: Optional custom CLI command name (defaults to kebab-cased class name).
         positional: Optional field name or list of field names to treat as positional CLI arguments.
         aliases: Optional alias or list of aliases (can be intra-group like 'find' or cross-group like 'search.user').
+        hidden_aliases: Optional alias or list of aliases to register with hidden=True.
         help: Optional help text for the command.
         output_format: Optional presenter output format.
         group: Optional sub-command group name or nested group path (e.g. 'user', 'user.profile').
         feature_flag: Optional feature flag key required to execute the command.
+        hidden: Whether to hide the query command from terminal --help displays.
 
     Returns:
         Decorated Query class with attached CLI metadata.
@@ -166,10 +179,12 @@ def cli_query(
             name=name,
             positional=_normalize_tokens(positional),
             aliases=_normalize_tokens(aliases),
+            hidden_aliases=_normalize_tokens(hidden_aliases),
             help=help,
             output_format=output_format,
             group=group,
             feature_flag=feature_flag,
+            hidden=hidden,
         )
         setattr(cls, _CLI_METADATA_ATTR, meta)
         return cls
@@ -195,8 +210,6 @@ def feature_flag_command(
     Returns:
         Decorator wrapping the target callable.
     """
-    from functools import wraps
-
     import typer
 
     from hexastack_core.adapters.feature_flags.config import ConfigFeatureFlagAdapter