mad-cli 0.4.0__py3-none-any.whl

mad_cli/__init__.py

@@ -0,0 +1,3 @@
+"""mad-cli — operator CLI for Mad (installs and manages mad-edge containers)."""
+
+__version__ = "0.4.0"

mad_cli/__main__.py

@@ -0,0 +1,6 @@
+"""Enable ``python -m mad_cli``."""
+
+from mad_cli.app import main
+
+if __name__ == "__main__":
+    main()

mad_cli/app.py

@@ -0,0 +1,77 @@
+"""Typer application wiring and the ``mad`` console-script entry point."""
+
+import typer
+
+from mad_cli import __version__
+from mad_cli.commands import config as config_cmd
+from mad_cli.commands import install as install_cmd
+from mad_cli.commands import instances as instances_cmd
+from mad_cli.commands import keys as keys_cmd
+from mad_cli.commands import lifecycle as lifecycle_cmd
+from mad_cli.commands import profiles as profiles_cmd
+from mad_cli.commands import service as service_cmd
+from mad_cli.commands import versions as versions_cmd
+
+app = typer.Typer(
+    no_args_is_help=True,
+    add_completion=False,
+    help="Mad operator CLI — install and manage mad-edge containers.",
+)
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        typer.echo(__version__)
+        raise typer.Exit()
+
+
+@app.callback()
+def _root(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        callback=_version_callback,
+        is_eager=True,
+        help="Show the mad-cli version and exit.",
+    ),
+) -> None:
+    """Mad operator CLI — install and manage mad-edge containers."""
+
+
+# ── install ──────────────────────────────────────────────────────────────────
+app.command("install")(install_cmd.install)
+
+# ── lifecycle ────────────────────────────────────────────────────────────────
+app.command("start")(lifecycle_cmd.start)
+app.command("stop")(lifecycle_cmd.stop)
+app.command("restart")(lifecycle_cmd.restart)
+app.command("status")(lifecycle_cmd.status)
+app.command("logs")(lifecycle_cmd.logs)
+app.command("shell")(lifecycle_cmd.shell)
+
+# ── inventory ────────────────────────────────────────────────────────────────
+app.command("list")(instances_cmd.list_)
+app.command("info")(instances_cmd.info_cmd)
+app.command("adopt")(instances_cmd.adopt)
+
+# ── versions ─────────────────────────────────────────────────────────────────
+app.command("versions")(versions_cmd.versions)
+app.command("update")(versions_cmd.update)
+
+# ── keys & config ─────────────────────────────────────────────────────────────
+app.add_typer(keys_cmd.keys_app, name="keys")
+app.add_typer(config_cmd.config_app, name="config")
+app.add_typer(profiles_cmd.profiles_app, name="profiles")
+
+# ── service mode (HTTP API) ───────────────────────────────────────────────────
+app.command("serve")(service_cmd.serve)
+app.add_typer(service_cmd.service_app, name="service")
+
+
+def main() -> None:
+    """Console-script entry point (``mad``)."""
+    app()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

mad_cli/commands/__init__.py

@@ -0,0 +1,5 @@
+"""Typer command surface for the ``mad`` CLI.
+
+Modules here own the operator-facing UX only; every side effect (docker,
+filesystem, templating) is delegated to ``mad_cli.core`` per CONTRACTS.md.
+"""

mad_cli/commands/_adapt.py

@@ -0,0 +1,41 @@
+"""Shared CLI adapter helpers: instance resolution and use-case error mapping.
+
+The command modules are thin adapters over :mod:`mad_cli.core.usecases`; this maps
+the framework-free :class:`~mad_cli.core.usecases.errors.UseCaseError` vocabulary
+onto the CLI idiom (an ``error(...)`` line plus ``typer.Exit(1)``) with the
+operator-facing hints (``mad install`` / ``mad list``).
+"""
+
+from __future__ import annotations
+
+from typing import NoReturn
+
+import typer
+
+from mad_cli.core.instance import Instance
+from mad_cli.core.usecases import instances as uc_instances
+from mad_cli.core.usecases.errors import AmbiguousInstanceError, NotFoundError, UseCaseError
+from mad_cli.ui.console import error
+
+
+def die(msg: str) -> NoReturn:
+    """Print an error and exit non-zero."""
+    error(msg)
+    raise typer.Exit(1)
+
+
+def fail(exc: UseCaseError) -> NoReturn:
+    """Render a use-case failure verbatim and exit non-zero."""
+    die(str(exc))
+
+
+def resolve_or_die(name: str | None) -> Instance:
+    """Resolve ``name`` (or the sole instance) or exit with an actionable hint."""
+    try:
+        return uc_instances.resolve_instance(name)
+    except NotFoundError:
+        if name is not None:
+            die(f"Instance {name!r} not found. Run `mad list` to see available instances.")
+        die("No instances found. Run `mad install` first.")
+    except AmbiguousInstanceError as exc:
+        die(str(exc))

mad_cli/commands/_common.py

@@ -0,0 +1,12 @@
+"""Small presentation helpers shared across commands.
+
+Secret detection now lives in the framework-free engine
+(:func:`mad_cli.core.keyspec.is_secret_key`) so the HTTP surface and the CLI
+share one masking rule; it is re-exported here for the command modules.
+"""
+
+from __future__ import annotations
+
+from mad_cli.core.keyspec import is_secret_key
+
+__all__ = ["is_secret_key"]

mad_cli/commands/config.py

@@ -0,0 +1,94 @@
+"""``mad config get|set|unset`` — read and edit an instance's ``.env`` values.
+
+Thin adapter over :mod:`mad_cli.core.usecases.configvals` — the general-purpose
+``.env`` editor (``mad keys`` is the credential-aware front end). Secret-looking
+values are masked on read unless ``--reveal`` is passed, and a handful of known
+keys are validated on write.
+"""
+
+from __future__ import annotations
+
+import typer
+from rich.table import Table
+
+from mad_cli.commands._adapt import fail, resolve_or_die
+from mad_cli.core.instance import Instance
+from mad_cli.core.usecases import configvals as uc
+from mad_cli.core.usecases.errors import NotFoundError, ValidationError
+from mad_cli.ui.console import console, error, info, ok, warn
+
+config_app = typer.Typer(
+    no_args_is_help=True,
+    add_completion=False,
+    help="Read and edit an instance's .env configuration.",
+)
+
+_INSTANCE_OPTION = typer.Option(
+    None, "--instance", "-i", help="Instance name (optional when exactly one instance exists)."
+)
+
+
+def _restart_hint(instance: Instance) -> None:
+    info(f"Restart the instance to apply: mad restart {instance.name}")
+
+
+@config_app.command("get")
+def get(
+    key: str | None = typer.Argument(None, help="Env key to read. Omit to list every value."),
+    instance: str | None = _INSTANCE_OPTION,
+    reveal: bool = typer.Option(False, "--reveal", help="Show secret values in full."),
+) -> None:
+    """Print one ``.env`` value, or the whole file (secrets masked)."""
+    inst = resolve_or_die(instance)
+
+    if key is None:
+        table = Table(title=f".env — {inst.name}")
+        table.add_column("Key", style="bold", no_wrap=True)
+        table.add_column("Value")
+        for item in uc.list_config(inst):
+            table.add_row(item.key, item.display(reveal=reveal))
+        console.print(table)
+        return
+
+    try:
+        item = uc.get_config(inst, key)
+    except NotFoundError:
+        error(f"{key} is not set on {inst.name}.")
+        raise typer.Exit(1) from None
+    console.print(item.display(reveal=reveal), markup=False, highlight=False)
+
+
+@config_app.command("set")
+def set_value(
+    key: str = typer.Argument(..., help="Env key to write."),
+    value: str = typer.Argument(..., help="Value to store."),
+    instance: str | None = _INSTANCE_OPTION,
+) -> None:
+    """Set an ``.env`` value, validating a handful of known keys."""
+    inst = resolve_or_die(instance)
+    try:
+        item, compose_baked = uc.set_config(inst, key, value)
+    except ValidationError as exc:
+        fail(exc)
+
+    ok(f"Set {key} = {item.display()} on {inst.name}.")
+    if compose_baked:
+        warn(
+            f"{key} was baked into compose.yml at install time. This updates .env only; "
+            "a port/bind change needs the instance regenerated (v0.3+) to take effect."
+        )
+    _restart_hint(inst)
+
+
+@config_app.command("unset")
+def unset(
+    key: str = typer.Argument(..., help="Env key to remove."),
+    instance: str | None = _INSTANCE_OPTION,
+) -> None:
+    """Remove a key from the instance's ``.env``."""
+    inst = resolve_or_die(instance)
+    if not uc.unset_config(inst, key):
+        warn(f"{key} is not set on {inst.name}; nothing to remove.")
+        return
+    ok(f"Unset {key} on {inst.name}.")
+    _restart_hint(inst)