zen-cli 0.1.1__tar.gz → 0.1.4__tar.gz

{zen_cli-0.1.1 → zen_cli-0.1.4}/.gitignore

@@ -8,5 +8,8 @@ build/
 __pycache__/
 *.py[cod]
 .pypirc
+.env
 .coverage
 htmlcov/
+temp/
+cli-ref/

zen_cli-0.1.4/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.5
+Name: zen-cli
+Version: 0.1.4
+Summary: Command-line toolbox for Zen Cloud PC. Operate orgs, pools, VMs, and tasks; call ZDS APIs; expose a stdio MCP server.
+Project-URL: Homepage, https://pypi.org/project/zen-cli/
+Author: zen-cli authors
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: authlib
+Requires-Dist: click>=8.1
+Requires-Dist: coloredlogs
+Requires-Dist: httpx2
+Requires-Dist: mcp>=2
+Requires-Dist: portalocker[win32]
+Requires-Dist: pydantic
+Requires-Dist: pyjwt
+Requires-Dist: python-dotenv
+Requires-Dist: pyyaml
+Requires-Dist: questionary
+Requires-Dist: tabulate
+Requires-Dist: yumako
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: release
+Requires-Dist: build; extra == 'release'
+Requires-Dist: twine; extra == 'release'
+Description-Content-Type: text/markdown
+
+# zen-cli
+
+[![PyPI](https://img.shields.io/pypi/v/zen-cli?logo=pypi&logoColor=white)](https://pypi.org/project/zen-cli/) [![Python](https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![PyPI downloads](https://img.shields.io/pypi/dm/zen-cli)](https://pypi.org/project/zen-cli/) [![Wheel](https://img.shields.io/pypi/wheel/zen-cli)](https://pypi.org/project/zen-cli/) [![OS](https://img.shields.io/badge/OS-macOS%20%7C%20Linux%20%7C%20Windows-informational)](https://pypi.org/project/zen-cli/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](https://img.shields.io/badge/mypy-checked-2A6DB2)](https://mypy-lang.org/) [![Click](https://img.shields.io/badge/cli-Click%208-4584b6)](https://click.palletsprojects.com/) [![Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5)](https://github.com/pypa/hatch)
+
+Command-line toolbox for Zen Cloud PC, designed for AI and human.
+
+## Contents
+
+- [Try it out](#try-it-out)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+    - [Mac & Linux](#mac--linux)
+    - [Windows](#windows)
+  - [Use the CLI](#use-the-cli)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Try it out
+
+### Prerequisites
+
+* Python 3.12 or newer
+* Pip
+
+### Installation
+
+#### Mac & Linux
+
+```text
+pip install zen-cli
+```
+
+#### Windows
+
+```text
+pip install zen-cli
+```
+
+If Python was installed without “Add python to PATH”, add Python and its `Scripts` directory to PATH.
+
+### Use the CLI
+
+```text
+zen login
+zen auth status
+zen auth details
+zen auth token
+```
+
+`zen login` reuses a valid cached token or configured credentials (API token, client id/secret). If neither is available it starts device-code login. It does not print the access token. Machine login is `zen login --client-id` / `--client-secret`. `zen auth status` is JSON (`logged_in`, `method`, `ttl`). `zen auth details` is the JWT and org. `zen auth token` is the bearer (`--service` on details/token). `zen auth refresh` refreshes the cached token.
+
+Run a command, for example, list pools:
+
+```text
+zen pool list
+```
+
+## Documentation
+
+* [User guide](docs/user-guide.md) — profiles, flags, payloads, and command conventions
+* [Cheatsheet](docs/cheatsheet.md) — command examples
+* [Developer guide](docs/dev.md) — build, test, and package layout
+
+## License
+
+Licensed under the MIT License. See [LICENSE](LICENSE).

zen_cli-0.1.4/README.md

@@ -0,0 +1,66 @@
+# zen-cli
+
+[![PyPI](https://img.shields.io/pypi/v/zen-cli?logo=pypi&logoColor=white)](https://pypi.org/project/zen-cli/) [![Python](https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![PyPI downloads](https://img.shields.io/pypi/dm/zen-cli)](https://pypi.org/project/zen-cli/) [![Wheel](https://img.shields.io/pypi/wheel/zen-cli)](https://pypi.org/project/zen-cli/) [![OS](https://img.shields.io/badge/OS-macOS%20%7C%20Linux%20%7C%20Windows-informational)](https://pypi.org/project/zen-cli/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](https://img.shields.io/badge/mypy-checked-2A6DB2)](https://mypy-lang.org/) [![Click](https://img.shields.io/badge/cli-Click%208-4584b6)](https://click.palletsprojects.com/) [![Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5)](https://github.com/pypa/hatch)
+
+Command-line toolbox for Zen Cloud PC, designed for AI and human.
+
+## Contents
+
+- [Try it out](#try-it-out)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+    - [Mac & Linux](#mac--linux)
+    - [Windows](#windows)
+  - [Use the CLI](#use-the-cli)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Try it out
+
+### Prerequisites
+
+* Python 3.12 or newer
+* Pip
+
+### Installation
+
+#### Mac & Linux
+
+```text
+pip install zen-cli
+```
+
+#### Windows
+
+```text
+pip install zen-cli
+```
+
+If Python was installed without “Add python to PATH”, add Python and its `Scripts` directory to PATH.
+
+### Use the CLI
+
+```text
+zen login
+zen auth status
+zen auth details
+zen auth token
+```
+
+`zen login` reuses a valid cached token or configured credentials (API token, client id/secret). If neither is available it starts device-code login. It does not print the access token. Machine login is `zen login --client-id` / `--client-secret`. `zen auth status` is JSON (`logged_in`, `method`, `ttl`). `zen auth details` is the JWT and org. `zen auth token` is the bearer (`--service` on details/token). `zen auth refresh` refreshes the cached token.
+
+Run a command, for example, list pools:
+
+```text
+zen pool list
+```
+
+## Documentation
+
+* [User guide](docs/user-guide.md) — profiles, flags, payloads, and command conventions
+* [Cheatsheet](docs/cheatsheet.md) — command examples
+* [Developer guide](docs/dev.md) — build, test, and package layout
+
+## License
+
+Licensed under the MIT License. See [LICENSE](LICENSE).

zen_cli-0.1.4/pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zen-cli"
+version = "0.1.4"
+description = "Command-line toolbox for Zen Cloud PC. Operate orgs, pools, VMs, and tasks; call ZDS APIs; expose a stdio MCP server."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+authors = [{ name = "zen-cli authors" }]
+dependencies = [
+    "authlib",
+    "click>=8.1",
+    "coloredlogs",
+    "httpx2",
+    "mcp>=2",
+    "python-dotenv",
+    "pydantic",
+    "portalocker[win32]",
+    "PyJWT",
+    "pyyaml",
+    "questionary",
+    "tabulate",
+    "yumako",
+]
+
+[project.optional-dependencies]
+dev = ["build", "pre-commit", "ruff", "mypy"]
+release = ["build", "twine"]
+
+[project.scripts]
+zen = "zen_cli.cli:main"
+
+[project.urls]
+Homepage = "https://pypi.org/project/zen-cli/"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/zen_cli", "tests", "README.md", "LICENSE"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 120
+src = ["src"]
+exclude = ["cli-ref"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src"]
+
+[[tool.mypy.overrides]]
+module = ["mcp", "mcp.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = [
+    "yumako",
+    "yumako.*",
+    "authlib",
+    "authlib.*",
+    "yaml",
+    "httpx2",
+    "httpx2.*",
+]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["zen_cli.cmds", "zen_cli.cmds.*", "zen_cli.ctxp", "zen_cli.ctxp.*"]
+disallow_untyped_decorators = false

zen_cli-0.1.4/src/zen_cli/__init__.py

@@ -0,0 +1,5 @@
+"""zen-cli package."""
+
+import httpx2
+
+httpx2.alias_httpx()

zen_cli-0.1.4/src/zen_cli/__main__.py

@@ -0,0 +1,4 @@
+from zen_cli.cli import main
+
+if __name__ == "__main__":
+    main()

zen_cli-0.1.4/src/zen_cli/cli.py

@@ -0,0 +1,176 @@
+import logging
+import os
+import sys
+from pathlib import Path
+from typing import Any
+
+import click
+from dotenv import load_dotenv
+from yumako import env
+
+import zen_cli.ctxp as ctxp
+from zen_cli.ctxp.cli_processor import register_commands
+
+_PACKAGE_DIR = Path(__file__).resolve().parent
+_COMMANDS_DIR = _PACKAGE_DIR / "cmds"
+_CONFIG_DIR = _PACKAGE_DIR / "config"
+_commands_loaded = False
+
+
+# -----------------------------------------------------------
+import zen_cli.ctxp.logger as logger  # noqa: E402
+
+logger.setup()
+logging.getLogger("charset_normalizer").setLevel(logging.WARN)
+logging.getLogger("csp").setLevel(logging.INFO)
+logging.getLogger("context").setLevel(logging.WARN)
+logging.getLogger("init").setLevel(logging.WARN)
+logging.getLogger("profile").setLevel(logging.WARN)
+logging.getLogger("httpx").setLevel(logging.WARN)
+logging.getLogger("httpx2").setLevel(logging.WARN)
+logging.getLogger("urllib3").setLevel(logging.ERROR)
+# logging.getLogger("zen_cli.sglib.login_support").setLevel(logging.DEBUG)
+# logging.getLogger("login_support").setLevel(logging.DEBUG)
+# -----------------------------------------------------------
+import zen_cli.sglib.ez_client as ez_client  # noqa: E402
+
+ez_client._print_http_error = False
+
+CONTEXT_SETTINGS = {
+    "help_option_names": ["-h", "--help"],
+    "max_content_width": 160,
+}
+
+
+def _apply_readonly() -> None:
+    data = ctxp.profile.current(exit_on_failure=False)
+    if not data:
+        return
+    is_readonly = data.get("readonly")
+    if isinstance(is_readonly, str):
+        is_readonly = is_readonly.strip().lower() in ("1", "true", "yes")
+    else:
+        is_readonly = bool(is_readonly)
+    if is_readonly:
+        from zen_cli.util import readonly as readonly_support
+
+        ez_client.set_readonly(True, readonly_support.ALLOW_PATHS)
+
+
+def _enable_verbose() -> None:
+    root = logging.getLogger()
+    root.setLevel(logging.DEBUG)
+    for handler in root.handlers:
+        handler.setLevel(logging.DEBUG)
+    for name in (
+        "zen_cli",
+        "csp",
+        "profile",
+        "httpx",
+        "httpx2",
+        "httpcore",
+        "authlib",
+    ):
+        logging.getLogger(name).setLevel(logging.DEBUG)
+
+
+def _check_upgrade() -> None:
+    check_flag_from_env = env.bool("HCS_CLI_CHECK_UPGRADE", True)
+    if not check_flag_from_env:
+        return
+    if os.environ.get("_ZEN_COMPLETE"):
+        return
+    if len(sys.argv) > 1 and sys.argv[1] in ("upgrade", "mcp", "completion"):
+        return
+    from zen_cli.util.versions import check_upgrade
+
+    check_upgrade()
+
+
+@click.group(name="zen", context_settings=CONTEXT_SETTINGS)
+@click.version_option(package_name="zen-cli", prog_name="zen")
+@click.option(
+    "--profile",
+    "-p",
+    type=str,
+    required=False,
+    help="Specify the profile to use. Optional.",
+)
+@click.option(
+    "--mdc",
+    type=str,
+    required=False,
+    help=("MDC name from profile zds.mdcs (e.g. beijing, singapore). Default is the first zds.mdcs entry."),
+)
+@click.option(
+    "--check-upgrade/--no-check-upgrade",
+    default=None,
+    help="Check for a new zen-cli version. On by default. Or set HCS_CLI_CHECK_UPGRADE=false.",
+)
+@click.option(
+    "--telemetry/--no-telemetry",
+    default=None,
+    help="Send command telemetry. Off by default. Or set ZEN_CLI_TELEMETRY=true.",
+)
+@click.option(
+    "--verbose",
+    "-v",
+    is_flag=True,
+    default=False,
+    help="Print debug logs, including HTTP method and URL.",
+)
+def cli(
+    profile: str,
+    mdc: str,
+    check_upgrade: bool | None,
+    telemetry: bool | None,
+    verbose: bool,
+    **kwargs: Any,
+) -> None:
+    """zen command-line interface."""
+    if verbose:
+        _enable_verbose()
+
+    if check_upgrade is not False:
+        _check_upgrade()
+
+    if telemetry is True:
+        ctxp.telemetry.enable()
+    elif telemetry is False:
+        ctxp.telemetry.disable()
+
+    if profile:
+        ctxp.profile.activate(profile, persist=False)
+
+    from zen_cli.ctxp._init import _initialized_app_name
+
+    if not _initialized_app_name:
+        return
+    from zen_cli.support import profile as profile_support
+
+    profile_support.ensure_standard_profiles(interactive=False)
+
+    if mdc:
+        from zen_cli.sglib import mdc as mdc_session
+
+        mdc_session.set(mdc)
+
+    _apply_readonly()
+    load_commands()
+
+
+def load_commands() -> None:
+    """Attach built-in and cmds/ commands without running Click."""
+    global _commands_loaded
+    if _commands_loaded:
+        return
+    register_commands(cli, str(_COMMANDS_DIR))
+    _commands_loaded = True
+
+
+def main() -> None:
+    ctxp.init(app_name="zen", config_path=str(_CONFIG_DIR))
+    load_dotenv(".env")
+    if os.environ.get("_ZEN_COMPLETE"):
+        ctxp.telemetry.disable()
+    ctxp.init_cli(main_cli=cli, commands_dir=str(_COMMANDS_DIR))

zen_cli-0.1.4/src/zen_cli/cmds/activity/__init__.py

@@ -0,0 +1 @@
+help = "System activity commands."

zen_cli-0.1.4/src/zen_cli/cmds/activity/get.py

@@ -0,0 +1,20 @@
+from typing import Any
+
+import click
+
+import zen_cli.sglib.cli_options as cli
+from zen_cli.ctxp import recent
+from zen_cli.service import activity
+
+
+@click.command()
+@cli.org_id
+@click.argument("id", type=str, required=False)
+def get(org: str, id: str) -> Any:
+    """Get a system activity by ID. Without an argument, use the recent activity."""
+    id = recent.require("activity", id)
+    org_id = None if org == "all" else cli.get_org_id(org)
+    ret = activity.get(id, org_id=org_id)
+    if ret:
+        return ret
+    return "", 1

zen_cli-0.1.4/src/zen_cli/cmds/activity/list.py

@@ -0,0 +1,157 @@
+from typing import Any
+
+import click
+
+import zen_cli.sglib.cli_options as cli
+from zen_cli.ctxp import recent, util
+from zen_cli.service import activity
+
+_RESOURCE_TYPES = [
+    "ORG",
+    "ORG_PREFERENCE",
+    "DATACENTER",
+    "POOL",
+    "ENTITLEMENT",
+    "VM",
+    "EDGE",
+    "SAG",
+    "TASK",
+    "PROVIDER_INSTANCE",
+    "NET_INFRA",
+    "EXPRESS_DEPLOYMENT",
+    "POOL_GROUP",
+    "IMAGE",
+    "SITE",
+    "SPEC",
+    "SESSION",
+    "VMAGENT",
+    "NOTIFICATION",
+]
+
+_TABLE_MAPPING = {
+    "code": "Code",
+    "severity": "Severity",
+    "initiator": "Initiator",
+    "serviceName": "Service",
+    "resourceId": "Resource",
+    "traceId": "Trace",
+}
+
+
+def _format_activity_table(data: Any) -> Any:
+    for d in data:
+        if d.get("timestamp") and not d.get("createdAt"):
+            d["createdAt"] = d["timestamp"]
+        if not d.get("name"):
+            d["name"] = d.get("resourceName") or d.get("code") or ""
+        if not d.get("type"):
+            d["type"] = d.get("resourceType")
+    return util.default_table_formatter(data, _TABLE_MAPPING)
+
+
+@click.command(name="list")
+@cli.org_id
+@click.option("--service-name", type=str, required=False, help="Filter by service name.")
+@click.option("--code", type=str, required=False, help="Filter by activity code.")
+@click.option("--trace-id", type=str, required=False, help="Filter by trace ID.")
+@click.option("--span-id", type=str, required=False, help="Filter by span ID.")
+@click.option("--resource-id", type=str, required=False, help="Filter by resource ID.")
+@click.option("--resource-name", type=str, required=False, help="Filter by resource name.")
+@click.option("--task-id", type=str, required=False, help="Filter by task ID.")
+@click.option("--parent-id", type=str, required=False, help="Filter by parent activity ID.")
+@click.option("--initiator", type=str, required=False, help="Filter by initiator.")
+@click.option(
+    "--initiator-type",
+    type=click.Choice(["SYSTEM", "OPS", "CUSTOMER_ADMIN", "USER"], case_sensitive=False),
+    required=False,
+    help="Filter by initiator type.",
+)
+@click.option(
+    "--resource-type",
+    type=click.Choice(_RESOURCE_TYPES, case_sensitive=False),
+    required=False,
+    help="Filter by resource type.",
+)
+@click.option(
+    "--severity",
+    type=click.Choice(["CRITICAL", "WARNING", "INFO", "TRIVIAL"], case_sensitive=False),
+    required=False,
+    help="Filter by severity.",
+)
+@click.option(
+    "--status",
+    type=click.Choice(
+        ["QUEUED", "START", "PROGRESS", "SUCCESS", "ERROR", "CANCELLED"],
+        case_sensitive=False,
+    ),
+    required=False,
+    help="Filter by status.",
+)
+@click.option(
+    "--timestamp-from",
+    type=str,
+    required=False,
+    help="Inclusive lower bound (ISO-8601).",
+)
+@click.option(
+    "--timestamp-to",
+    type=str,
+    required=False,
+    help="Inclusive upper bound (ISO-8601).",
+)
+@cli.sort
+@cli.limit
+@cli.formatter(_format_activity_table)
+def list_activities(
+    org: str,
+    service_name: str,
+    code: str,
+    trace_id: str,
+    span_id: str,
+    resource_id: str,
+    resource_name: str,
+    task_id: str,
+    parent_id: str,
+    initiator: str,
+    initiator_type: str,
+    resource_type: str,
+    severity: str,
+    status: str,
+    timestamp_from: str,
+    timestamp_to: str,
+    sort: str,
+    limit: int,
+) -> Any:
+    """List system activities."""
+    org_id = None if org == "all" else cli.get_org_id(org)
+    if initiator_type:
+        initiator_type = initiator_type.upper()
+    if resource_type:
+        resource_type = resource_type.upper()
+    if severity:
+        severity = severity.upper()
+    if status:
+        status = status.upper()
+
+    ret = activity.list(
+        org_id=org_id,
+        service_name=service_name,
+        code=code,
+        trace_id=trace_id,
+        span_id=span_id,
+        resource_id=resource_id,
+        resource_name=resource_name,
+        task_id=task_id,
+        parent_id=parent_id,
+        initiator=initiator,
+        initiator_type=initiator_type,
+        resource_type=resource_type,
+        severity=severity,
+        status=status,
+        timestamp_from=timestamp_from,
+        timestamp_to=timestamp_to,
+        sort=sort,
+        limit=limit,
+    )
+    recent.helper.default_list(ret, "activity")
+    return ret