flowmesh-cli 0.1.0__tar.gz

flowmesh_cli-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The FlowMesh Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

flowmesh_cli-0.1.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: flowmesh-cli
+Version: 0.1.0
+Summary: FlowMesh command line interface
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12.5
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.2.0
+Requires-Dist: websockets>=15.0
+Requires-Dist: flowmesh-sdk==0.1.0
+Provides-Extra: stack
+Requires-Dist: flowmesh-cli-stack==0.1.0; extra == "stack"
+Dynamic: license-file
+
+# FlowMesh CLI
+
+Standalone FlowMesh CLI package (`flowmesh-cli`).
+
+## Packages
+
+- `flowmesh-cli` (base): core commands — workflow, task, worker, node, ssh,
+  result, system, plus basic `info` / `health` helpers.
+- `flowmesh-cli-stack` (`cli/stack/`): stack deployment commands — build, up,
+  down, worker management, bundle, env helpers, doctor.
+
+Install with the `stack` extra to get both:
+
+```bash
+pip install "flowmesh[cli]"
+```
+
+The CLI entrypoint is `flowmesh`. Stack assets (compose, bake, env example) are
+bundled under `flowmesh_cli_stack/assets/`.

flowmesh_cli-0.1.0/README.md

@@ -0,0 +1,19 @@
+# FlowMesh CLI
+
+Standalone FlowMesh CLI package (`flowmesh-cli`).
+
+## Packages
+
+- `flowmesh-cli` (base): core commands — workflow, task, worker, node, ssh,
+  result, system, plus basic `info` / `health` helpers.
+- `flowmesh-cli-stack` (`cli/stack/`): stack deployment commands — build, up,
+  down, worker management, bundle, env helpers, doctor.
+
+Install with the `stack` extra to get both:
+
+```bash
+pip install "flowmesh[cli]"
+```
+
+The CLI entrypoint is `flowmesh`. Stack assets (compose, bake, env example) are
+bundled under `flowmesh_cli_stack/assets/`.

flowmesh_cli-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flowmesh-cli"
+version = "0.1.0"
+description = "FlowMesh command line interface"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = [
+    "typer>=0.12.5",
+    "pyyaml>=6.0.2",
+    "rich>=14.2.0",
+    "websockets>=15.0",
+    "flowmesh-sdk==0.1.0",
+]
+
+[project.optional-dependencies]
+stack = ["flowmesh-cli-stack==0.1.0"]
+
+[project.scripts]
+flowmesh = "flowmesh_cli.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

flowmesh_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flowmesh_cli-0.1.0/src/flowmesh_cli/__init__.py

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

flowmesh_cli-0.1.0/src/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-0.1.0/src/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-0.1.0/src/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-0.1.0/src/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}'")