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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexastack-cli
-Version: 0.8.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>
@@ -37,9 +37,11 @@ Description-Content-Type: text/markdown
 
 - **Nested Command Hierarchies**: Nest subcommands naturally (`app user create`, `app db migrate`) using `@cli_group`.
 - **Command Aliases**: Register multiple aliases for the same action (`app user new == app user create`).
+- **Typo Tolerance & Suggestions (`TyperSuggest`)**: Drop-in replacement for `typer.Typer` that intercepts unrecognized subcommands or flags, computes closest matches via Levenshtein distance, prompts interactively for confirmation, and exits cleanly in CI/non-interactive pipelines.
 - **Feature Flag Gating**: Gate CLI commands dynamically with `@feature_flag_command(...)` and `@cli_command(..., feature_flag=...)`.
 - **Rich Formatted & CI-Friendly Output**: Beautiful tables, panels, and spinners for interactive terminals; clean text/JSON streaming for CI/CD pipelines.
 - **Direct CQRS Dispatching**: Declaratively expose domain commands (`@cli_command`) and queries (`@cli_query`) with automatic parameter parsing and validation.
+- **Automated Demo Narration & Slicing (`CliNarrator`)**: Headless terminal recording generating asciinema streams, high-resolution `.webm` videos, chapterized `.checkpoint_segment()` flushes, and synchronized `.vtt` subtitles.
 
 ---
 
@@ -48,7 +50,8 @@ Description-Content-Type: text/markdown
 ```
 hexastack_cli/
 ├── domain/          # CliContext, OutputFormat enum
-├── adapters/        # Rich presenters, Typer command runners
+├── adapters/        # Rich presenters, Typer command runners, TyperSuggest
+├── testing/         # CliNarrator, TerminalEvent (demo video & VTT recorder)
 └── infra/           # create_cli_app, CliBootstrapper (order=40), @cli_command, @cli_query, @cli_group, @feature_flag_command
 ```
 
@@ -56,7 +59,7 @@ hexastack_cli/
 
 | Category | Exports |
 |---|---|
-| **Application Factory** | `create_cli_app`, `CliBootstrapper` (order=30) |
+| **Application Factory & Typo Tolerance** | `create_cli_app`, `TyperSuggest`, `SuggestGroup`, `SuggestCommand`, `CliBootstrapper` (order=40) |
 | **Decorators** | `@cli_command`, `@cli_query`, `@cli_group`, `@feature_flag_command` |
 | **Presenters** | `RichTerminalPresenter`, `ConsolePresenter`, `TablePresenter`, `JsonPresenter` |
 | **Testing & Demo Narration** | `CliNarrator`, `TerminalEvent` |
@@ -148,3 +151,57 @@ cli_query("status", aliases=["st", "health"], help="Check status of a service")(
 runtime = bootstrap(packages_to_scan=[__name__])
 cli_app = runtime.get("cli_app")
 ```
+
+---
+
+## 6. Standalone Typo-Tolerant CLI (`TyperSuggest`)
+
+`TyperSuggest` is a drop-in replacement for `typer.Typer`. It intercepts mistyped commands and options, presenting suggestions and interactive confirmations without throwing cryptic syntax errors:
+
+```python
+from hexastack_cli.adapters import TyperSuggest
+
+app = TyperSuggest(help="My Resilient Service CLI")
+
+
+@app.command()
+def deploy(environment: str = "staging", force: bool = False):
+    print(f"Deploying to {environment} (force={force})")
+
+
+if __name__ == "__main__":
+    app()
+```
+
+```bash
+$ python cli.py deply
+Unrecognized command 'deply'. Did you mean 'deploy'? [y/N]: y
+Deploying to staging (force=False)
+
+$ python cli.py deploy --frc
+Unrecognized option '--frc'. Did you mean '--force'? [y/N]: y
+Deploying to staging (force=True)
+```
+
+In automated CI environments or redirected streams (`not sys.stdin.isatty()`), `TyperSuggest` prints the suggested correction to `stderr` and exits cleanly with error code `2` without hanging.
+
+---
+
+## 7. Automated Demo Recording & Video Slicing (`CliNarrator`)
+
+```python
+from hexastack_cli.testing import CliNarrator
+
+narrator = CliNarrator(record_video=True)
+narrator.say("Scaffolding microservice...")
+narrator.run("hexastack new web-api billing-service")
+
+# Flush Chapter 1 video & VTT segment
+narrator.checkpoint_segment("ch01-scaffolding")
+
+narrator.say("Applying SQLite database migrations...")
+narrator.run("hexastack db migrate")
+
+# Flush Chapter 2 video & VTT segment
+narrator.checkpoint_segment("ch02-migrations")
+```

{hexastack_cli-0.8.0 → hexastack_cli-0.10.0}/README.md

@@ -20,9 +20,11 @@
 
 - **Nested Command Hierarchies**: Nest subcommands naturally (`app user create`, `app db migrate`) using `@cli_group`.
 - **Command Aliases**: Register multiple aliases for the same action (`app user new == app user create`).
+- **Typo Tolerance & Suggestions (`TyperSuggest`)**: Drop-in replacement for `typer.Typer` that intercepts unrecognized subcommands or flags, computes closest matches via Levenshtein distance, prompts interactively for confirmation, and exits cleanly in CI/non-interactive pipelines.
 - **Feature Flag Gating**: Gate CLI commands dynamically with `@feature_flag_command(...)` and `@cli_command(..., feature_flag=...)`.
 - **Rich Formatted & CI-Friendly Output**: Beautiful tables, panels, and spinners for interactive terminals; clean text/JSON streaming for CI/CD pipelines.
 - **Direct CQRS Dispatching**: Declaratively expose domain commands (`@cli_command`) and queries (`@cli_query`) with automatic parameter parsing and validation.
+- **Automated Demo Narration & Slicing (`CliNarrator`)**: Headless terminal recording generating asciinema streams, high-resolution `.webm` videos, chapterized `.checkpoint_segment()` flushes, and synchronized `.vtt` subtitles.
 
 ---
 
@@ -31,7 +33,8 @@
 ```
 hexastack_cli/
 ├── domain/          # CliContext, OutputFormat enum
-├── adapters/        # Rich presenters, Typer command runners
+├── adapters/        # Rich presenters, Typer command runners, TyperSuggest
+├── testing/         # CliNarrator, TerminalEvent (demo video & VTT recorder)
 └── infra/           # create_cli_app, CliBootstrapper (order=40), @cli_command, @cli_query, @cli_group, @feature_flag_command
 ```
 
@@ -39,7 +42,7 @@ hexastack_cli/
 
 | Category | Exports |
 |---|---|
-| **Application Factory** | `create_cli_app`, `CliBootstrapper` (order=30) |
+| **Application Factory & Typo Tolerance** | `create_cli_app`, `TyperSuggest`, `SuggestGroup`, `SuggestCommand`, `CliBootstrapper` (order=40) |
 | **Decorators** | `@cli_command`, `@cli_query`, `@cli_group`, `@feature_flag_command` |
 | **Presenters** | `RichTerminalPresenter`, `ConsolePresenter`, `TablePresenter`, `JsonPresenter` |
 | **Testing & Demo Narration** | `CliNarrator`, `TerminalEvent` |
@@ -131,3 +134,57 @@ cli_query("status", aliases=["st", "health"], help="Check status of a service")(
 runtime = bootstrap(packages_to_scan=[__name__])
 cli_app = runtime.get("cli_app")
 ```
+
+---
+
+## 6. Standalone Typo-Tolerant CLI (`TyperSuggest`)
+
+`TyperSuggest` is a drop-in replacement for `typer.Typer`. It intercepts mistyped commands and options, presenting suggestions and interactive confirmations without throwing cryptic syntax errors:
+
+```python
+from hexastack_cli.adapters import TyperSuggest
+
+app = TyperSuggest(help="My Resilient Service CLI")
+
+
+@app.command()
+def deploy(environment: str = "staging", force: bool = False):
+    print(f"Deploying to {environment} (force={force})")
+
+
+if __name__ == "__main__":
+    app()
+```
+
+```bash
+$ python cli.py deply
+Unrecognized command 'deply'. Did you mean 'deploy'? [y/N]: y
+Deploying to staging (force=False)
+
+$ python cli.py deploy --frc
+Unrecognized option '--frc'. Did you mean '--force'? [y/N]: y
+Deploying to staging (force=True)
+```
+
+In automated CI environments or redirected streams (`not sys.stdin.isatty()`), `TyperSuggest` prints the suggested correction to `stderr` and exits cleanly with error code `2` without hanging.
+
+---
+
+## 7. Automated Demo Recording & Video Slicing (`CliNarrator`)
+
+```python
+from hexastack_cli.testing import CliNarrator
+
+narrator = CliNarrator(record_video=True)
+narrator.say("Scaffolding microservice...")
+narrator.run("hexastack new web-api billing-service")
+
+# Flush Chapter 1 video & VTT segment
+narrator.checkpoint_segment("ch01-scaffolding")
+
+narrator.say("Applying SQLite database migrations...")
+narrator.run("hexastack db migrate")
+
+# Flush Chapter 2 video & VTT segment
+narrator.checkpoint_segment("ch02-migrations")
+```

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

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.8.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.8.0 → hexastack_cli-0.10.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "hexastack-cli"
-version = "0.8.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.10.0/src/hexastack_cli/adapters/__init__.py

@@ -0,0 +1,25 @@
+from hexastack_cli.adapters.presenter import RichTerminalPresenter
+from hexastack_cli.adapters.routing import (
+    register_cqrs_command,
+    register_cqrs_query,
+)
+from hexastack_cli.adapters.suggest import (
+    SuggestCommand,
+    SuggestGroup,
+    SuggestOptionParser,
+    TyperSuggest,
+    find_closest_match,
+    is_interactive,
+)
+
+__all__ = [
+    "find_closest_match",
+    "is_interactive",
+    "register_cqrs_command",
+    "register_cqrs_query",
+    "RichTerminalPresenter",
+    "SuggestCommand",
+    "SuggestGroup",
+    "SuggestOptionParser",
+    "TyperSuggest",
+]

{hexastack_cli-0.8.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)