flowmesh-cli 0.1.0__py3-none-any.whl

flowmesh_cli/__init__.py

@@ -0,0 +1 @@
+"""FlowMesh CLI package."""

flowmesh_cli/cli.py

@@ -0,0 +1,46 @@
+"""FlowMesh CLI entrypoint."""
+
+from importlib import import_module
+from importlib.util import find_spec
+
+import typer
+
+from .core.typer import get_typer
+
+
+def _register_optional(
+    module_name: str, app: typer.Typer, register_func: str = "register"
+) -> bool:
+    """Import and register a command module if it is installed.
+
+    Extras gate availability by deciding which modules are packaged. If a module
+    is missing, we silently skip it; unexpected import errors still bubble up.
+    """
+    package = __package__ if module_name.startswith(".") else None
+    spec = find_spec(module_name, package=package)
+    if spec is None:
+        return False
+    module = import_module(module_name, package=package)
+    register = getattr(module, register_func, None)
+    if register is None:
+        return False
+    register(app)
+    return True
+
+
+def build_cli_app() -> typer.Typer:
+    """Construct the CLI app by attaching available command groups."""
+    app = get_typer(help="FlowMesh command line interface.")
+
+    _register_optional(".commands", app)
+    _register_optional("flowmesh_cli_stack", app)
+
+    return app
+
+
+def main() -> None:
+    build_cli_app()()
+
+
+if __name__ == "__main__":
+    main()

flowmesh_cli/commands/__init__.py

@@ -0,0 +1,26 @@
+"""Command modules for the FlowMesh CLI."""
+
+import typer
+
+from .base import app as base_app
+from .node import app as node_app
+from .result import app as results_app
+from .ssh import app as ssh_app
+from .system import app as system_app
+from .task import app as task_app
+from .trace import app as trace_app
+from .worker import app as worker_app
+from .workflow import app as workflow_app
+
+
+def register(app: typer.Typer) -> None:
+    """Register command groups on the root app."""
+    app.add_typer(base_app)
+    app.add_typer(task_app, name="task")
+    app.add_typer(results_app, name="result")
+    app.add_typer(workflow_app, name="workflow")
+    app.add_typer(system_app, name="system")
+    app.add_typer(node_app, name="node")
+    app.add_typer(worker_app, name="worker")
+    app.add_typer(ssh_app, name="ssh")
+    app.add_typer(trace_app, name="trace")

flowmesh_cli/commands/base.py

@@ -0,0 +1,139 @@
+import json
+from pathlib import Path
+
+import typer
+from flowmesh.client import FlowMesh, resolve_config
+from flowmesh.config import DEFAULT_CONFIG_PATH, FlowMeshConfig
+from flowmesh.exceptions import FlowMeshError
+
+from ..core import logging
+from ..core.typer import get_typer
+
+app = get_typer()
+
+
+def _redact_api_key(
+    api_key: str | None, prefix: int | None = None, suffix: int | None = None
+) -> str | None:
+    if api_key is None:
+        return None
+
+    length = len(api_key)
+    if prefix is None and suffix is None:
+        prefix = suffix = 4
+        if length <= prefix + suffix:
+            return "*" * length  # If the key is too short, redact the entire key
+    elif prefix is None or suffix is None:
+        raise ValueError("Both prefix and suffix must be provided together")
+    elif length <= prefix + suffix:
+        raise ValueError(
+            "API key is too short to redact with the given prefix/suffix lengths"
+        )
+
+    masked_middle = "*" * (length - prefix - suffix)
+    return f"{api_key[:prefix]}{masked_middle}{api_key[-suffix:]}"
+
+
+@app.command()
+def init(
+    url: str = typer.Argument(
+        "http://localhost:8000",
+        help="FlowMesh server API URL (e.g., http://localhost:8000)",
+    ),
+    api_key: str | None = typer.Option(
+        None, "--api-key", help="Optional API key for authentication"
+    ),
+    config_path: Path = typer.Option(
+        DEFAULT_CONFIG_PATH, "--config", help="Path to save configuration file"
+    ),
+    force: bool = typer.Option(
+        False,
+        "--force",
+        "-f",
+        help="Overwrite existing config file without confirmation",
+        show_default=False,
+    ),
+) -> None:
+    """Initialize configuration for FlowMesh CLI."""
+    if config_path.exists():
+        if force:
+            logging.warning(f"Overwriting existing config at {config_path}")
+        else:
+            if not typer.confirm(
+                f"Config file {config_path} already exists. "
+                "Do you want to overwrite it?"
+            ):
+                raise typer.Exit()
+    config = FlowMeshConfig(url, api_key)
+    config.save(config_path)
+    logging.success(f"Config saved to {config_path}")
+
+
+@app.command()
+def deinit(config_path: Path = typer.Option(DEFAULT_CONFIG_PATH, "--config")) -> None:
+    """Delete saved configuration file."""
+    if config_path.exists():
+        config_path.unlink()
+        logging.success(f"Deleted config file {config_path}")
+    else:
+        logging.warning(f"No config file found at {config_path}")
+
+
+@app.command()
+def config(
+    config_path: Path = typer.Option(DEFAULT_CONFIG_PATH, "--config"),
+    source: str = typer.Option(
+        "auto", "--source", help="Configuration source: auto, file, or env"
+    ),
+    show_api_key: bool = typer.Option(
+        False, "--show-api-key", help="Show API key in plain text"
+    ),
+) -> None:
+    """Display current configuration."""
+    source = source.strip().lower()
+
+    match source:
+        case "file":
+            try:
+                cfg = FlowMeshConfig.from_file(config_path)
+            except Exception as exc:
+                logging.error(f"Error loading config from file: {exc}")
+                raise typer.Exit(code=1)
+        case "env":
+            try:
+                cfg = FlowMeshConfig.from_env()
+            except Exception as exc:
+                logging.error(f"Error loading config from environment: {exc}")
+                raise typer.Exit(code=1)
+        case "auto":
+            try:
+                cfg = resolve_config(
+                    base_url=None, api_key=None, config_path=config_path
+                )
+            except Exception as exc:
+                logging.error(f"Error resolving config: {exc}")
+                raise typer.Exit(code=1)
+        case _:
+            logging.error("Invalid --source value. Expected one of: auto, file, env")
+            raise typer.Exit(code=2)
+
+    cfg.api_key = cfg.api_key if show_api_key else _redact_api_key(cfg.api_key)
+    logging.log(json.dumps(cfg.to_mapping(), indent=2))
+
+
+@app.command()
+def info() -> None:
+    """Query server health status and basic system information."""
+    client = FlowMesh()
+    try:
+        resp = client.system.health()
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.log(resp.model_dump_json(indent=2))
+
+
+@app.command()
+def health() -> None:
+    """Check if the FlowMesh server is reachable and healthy."""
+    info()

flowmesh_cli/commands/node.py

@@ -0,0 +1,142 @@
+import json
+
+import typer
+from flowmesh import FlowMesh
+from flowmesh.exceptions import FlowMeshError
+from flowmesh.params import append_param, extend_params
+
+from ..core import logging
+from ..core.query import parse_query_filters
+from ..core.typer import get_typer
+
+app = get_typer(help="Manage nodes registered with FlowMesh.")
+
+
+@app.command()
+def info(node_id: str = typer.Argument(..., help="Node identifier")) -> None:
+    """Retrieve information for a specific node."""
+    client = FlowMesh()
+    try:
+        node = client.nodes.retrieve(node_id)
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.log(node.model_dump_json(indent=2))
+
+
+@app.command("list")
+def list_nodes(
+    node_id: str | None = typer.Option(None, "--id", help="Filter by node id"),
+    namespace: str | None = typer.Option(
+        None, "--namespace", help="Filter by node namespace"
+    ),
+    cluster: str | None = typer.Option(
+        None, "--cluster", help="Filter by node cluster"
+    ),
+    alias: str | None = typer.Option(None, "--alias", help="Filter by node alias"),
+    tag: list[str] | None = typer.Option(
+        None, "--tag", help="Filter by tag (repeatable)"
+    ),
+    query: list[str] | None = typer.Option(
+        None, "--query", "-q", help="Filter nodes by key=value pairs"
+    ),
+) -> None:
+    """List all nodes registered with FlowMesh."""
+    client = FlowMesh()
+    query_params = parse_query_filters(query)
+    try:
+        nodes = client.nodes.list(
+            node_id=node_id,
+            namespace=namespace,
+            cluster=cluster,
+            alias=alias,
+            tags=tag or None,
+            query_params=query_params,
+        )
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.log(json.dumps([s.model_dump(mode="json") for s in nodes], indent=2))
+
+
+worker_app = get_typer(help="Manage workers on nodes.")
+app.add_typer(worker_app, name="worker")
+
+
+@worker_app.command("list")
+def list_workers(
+    node_id: str | None = typer.Argument(None, help="Node identifier"),
+    worker_id: str | None = typer.Option(None, "--id", help="Filter by worker id"),
+    name: str | None = typer.Option(None, "--name", help="Filter by worker name"),
+    namespace: str | None = typer.Option(
+        None, "--namespace", help="Filter by worker namespace"
+    ),
+    cluster: str | None = typer.Option(
+        None, "--cluster", help="Filter by worker cluster"
+    ),
+    provider: str | None = typer.Option(
+        None, "--provider", help="Filter by worker provider"
+    ),
+    status: list[str] | None = typer.Option(
+        None, "--status", "-s", help="Filter by status (repeatable)"
+    ),
+    node_id_filter: str | None = typer.Option(
+        None, "--node-id", help="Filter by associated node id"
+    ),
+    node_alias: str | None = typer.Option(
+        None, "--node-alias", help="Filter by associated node alias"
+    ),
+    query: list[str] | None = typer.Option(
+        None, "--query", "-q", help="Filter workers by key=value pairs"
+    ),
+) -> None:
+    """List workers on a specific node or all nodes."""
+    client = FlowMesh()
+    query_params = parse_query_filters(query)
+    append_param(query_params, "id", worker_id)
+    append_param(query_params, "name", name)
+    append_param(query_params, "namespace", namespace)
+    append_param(query_params, "cluster", cluster)
+    append_param(query_params, "provider", provider)
+    extend_params(query_params, "status", status)
+    append_param(query_params, "node_id", node_id_filter)
+    append_param(query_params, "node_alias", node_alias)
+    try:
+        if node_id is None:
+            workers = client.nodes.list_all_workers(query_params=query_params)
+        else:
+            workers = client.nodes.list_workers(node_id, query_params=query_params)
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.log(json.dumps([w.model_dump(mode="json") for w in workers], indent=2))
+
+
+@worker_app.command("start")
+def start_worker(
+    node_id: str = typer.Argument(..., help="Node identifier"),
+    worker_name: str = typer.Argument(..., help="Worker name"),
+) -> None:
+    """Start a worker on a specific node."""
+    client = FlowMesh()
+    try:
+        client.nodes.start_worker(node_id, worker_name)
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.success(f"Worker '{worker_name}' started on node '{node_id}'")
+
+
+@worker_app.command("stop")
+def stop_worker(
+    node_id: str = typer.Argument(..., help="Node identifier"),
+    worker_name: str = typer.Argument(..., help="Worker name"),
+) -> None:
+    """Stop a worker on a specific node."""
+    client = FlowMesh()
+    try:
+        client.nodes.stop_worker(node_id, worker_name)
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.success(f"Worker '{worker_name}' stopped on node '{node_id}'")

flowmesh_cli/commands/result.py

@@ -0,0 +1,57 @@
+import json
+from pathlib import Path
+
+import typer
+from flowmesh import FlowMesh
+from flowmesh.exceptions import FlowMeshError
+
+from ..core import logging
+from ..core.typer import get_typer
+
+app = get_typer(help="Retrieve task execution results and output artifacts.")
+
+
+@app.command("fetch")
+def fetch(
+    task_id: str = typer.Argument(..., help="Task identifier"),
+    output: Path | None = typer.Option(
+        None, "--output", "-o", help="Directory to write result JSON"
+    ),
+) -> None:
+    """Download task result JSON and optionally save it to a local file."""
+    client = FlowMesh()
+    if output:
+        try:
+            payload, target, downloaded = client.results.materialize(task_id, output)
+        except FlowMeshError as exc:
+            logging.error(str(exc))
+            raise typer.Exit(code=1)
+        if downloaded:
+            logging.log(f"Downloaded images to {output / f'{task_id}-artifacts'}")
+        logging.log(f"Wrote result to {target}")
+        return
+
+    try:
+        payload = client.results.retrieve(task_id)
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)
+    logging.log(json.dumps(payload, indent=2))
+
+
+@app.command("download")
+def download_result_files(
+    task_id: str = typer.Argument(..., help="Task identifier"),
+    file_paths: list[str] = typer.Argument(..., help="List of file paths to download"),
+    output_dir: Path = typer.Option(
+        ..., "--output", "-o", help="Directory to save downloaded files"
+    ),
+) -> None:
+    """Download specified result files for a task."""
+    client = FlowMesh()
+    try:
+        for path in client.results.download_files(task_id, file_paths, output_dir):
+            logging.log(f"Wrote file to {path}")
+    except FlowMeshError as exc:
+        logging.error(str(exc))
+        raise typer.Exit(code=1)