zen-cli 0.1.6__tar.gz → 0.1.8__tar.gz

{zen_cli-0.1.6 → zen_cli-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: zen-cli
-Version: 0.1.6
+Version: 0.1.8
 Summary: CLI for Zen Desktop Service. Designed for AI and Human.
 Project-URL: Homepage, https://pypi.org/project/zen-cli/
 Author: zen-cli authors
@@ -18,6 +18,7 @@ Requires-Dist: pyjwt
 Requires-Dist: python-dotenv
 Requires-Dist: pyyaml
 Requires-Dist: questionary
+Requires-Dist: rich-click>=1.8
 Requires-Dist: tabulate
 Requires-Dist: yumako
 Provides-Extra: dev
@@ -34,43 +35,51 @@ Description-Content-Type: text/markdown
 
 [![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.
+面向 AI 和人的 Zen Cloud 命令行工具。
 
-## Contents
+## 目录
 
-- [Try it out](#try-it-out)
-  - [Prerequisites](#prerequisites)
-  - [Installation](#installation)
-    - [Mac & Linux](#mac--linux)
+- [试用](#试用)
+  - [前置条件](#前置条件)
+  - [安装](#安装)
+    - [Mac 与 Linux](#mac-与-linux)
     - [Windows](#windows)
-  - [Use the CLI](#use-the-cli)
-- [Documentation](#documentation)
-- [License](#license)
+  - [使用 CLI](#使用-cli)
+- [文档](#文档)
+- [许可证](#许可证)
 
-## Try it out
+## 试用
 
-### Prerequisites
+### 前置条件
 
-* Python 3.12 or newer
-* Pip
+* Python 3.12 或更新版本
+* [uv](https://docs.astral.sh/uv/) 或 [pipx](https://pipx.pypa.io/)
 
-### Installation
+### 安装
 
-#### Mac & Linux
+```text
+uv tool install zen-cli
+```
+
+或：
 
 ```text
-pip install zen-cli
+pipx install zen-cli
 ```
 
-#### Windows
+装完后若找不到 `zen`，跑 `uv tool update-shell` 或 `pipx ensurepath`，然后开一个新终端。Windows 同样适用。
+
+升级：
 
 ```text
-pip install zen-cli
+zen upgrade
+uv tool upgrade zen-cli
+pipx upgrade zen-cli
 ```
 
-If Python was installed without “Add python to PATH”, add Python and its `Scripts` directory to PATH.
+`zen upgrade` 会按当前是 uv、pipx 还是普通环境选择对应方式。
 
-### Use the CLI
+### 使用 CLI
 
 ```text
 zen login
@@ -79,20 +88,22 @@ 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
+* [用户指南](docs/user-guide.md) — profile、旗标、请求体和命令约定
+* [环境变量](docs/env.md) — `zen` 读取的环境变量
+* [速查](docs/cheatsheet.md) — 命令示例
+* [CLI 通用原则](docs/cli-principles.md) — 退出码、输出格式、通用参数和特例
+* [开发指南](docs/dev-guide.md) — 环境、`dev.py`、Jenkins 和如何加命令
+* [编码原则](docs/coding-principles.md) — 包划分和导入方向
 
-## License
+## 许可证
 
-Licensed under the MIT License. See [LICENSE](LICENSE).
+采用 MIT License。见 [LICENSE](LICENSE)。

zen_cli-0.1.8/README.md

@@ -0,0 +1,76 @@
+# 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)
+
+面向 AI 和人的 Zen Cloud 命令行工具。
+
+## 目录
+
+- [试用](#试用)
+  - [前置条件](#前置条件)
+  - [安装](#安装)
+    - [Mac 与 Linux](#mac-与-linux)
+    - [Windows](#windows)
+  - [使用 CLI](#使用-cli)
+- [文档](#文档)
+- [许可证](#许可证)
+
+## 试用
+
+### 前置条件
+
+* Python 3.12 或更新版本
+* [uv](https://docs.astral.sh/uv/) 或 [pipx](https://pipx.pypa.io/)
+
+### 安装
+
+```text
+uv tool install zen-cli
+```
+
+或：
+
+```text
+pipx install zen-cli
+```
+
+装完后若找不到 `zen`，跑 `uv tool update-shell` 或 `pipx ensurepath`，然后开一个新终端。Windows 同样适用。
+
+升级：
+
+```text
+zen upgrade
+uv tool upgrade zen-cli
+pipx upgrade zen-cli
+```
+
+`zen upgrade` 会按当前是 uv、pipx 还是普通环境选择对应方式。
+
+### 使用 CLI
+
+```text
+zen login
+zen auth status
+zen auth details
+zen auth token
+```
+
+
+跑一条命令，例如列出桌面池：
+
+```text
+zen pool list
+```
+
+## 文档
+
+* [用户指南](docs/user-guide.md) — profile、旗标、请求体和命令约定
+* [环境变量](docs/env.md) — `zen` 读取的环境变量
+* [速查](docs/cheatsheet.md) — 命令示例
+* [CLI 通用原则](docs/cli-principles.md) — 退出码、输出格式、通用参数和特例
+* [开发指南](docs/dev-guide.md) — 环境、`dev.py`、Jenkins 和如何加命令
+* [编码原则](docs/coding-principles.md) — 包划分和导入方向
+
+## 许可证
+
+采用 MIT License。见 [LICENSE](LICENSE)。

{zen_cli-0.1.6 → zen_cli-0.1.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "zen-cli"
-version = "0.1.6"
+version = "0.1.8"
 description = "CLI for Zen Desktop Service. Designed for AI and Human."
 readme = "README.md"
 license = "MIT"
@@ -14,6 +14,7 @@ authors = [{ name = "zen-cli authors" }]
 dependencies = [
     "authlib",
     "click>=8.1",
+    "rich-click>=1.8",
     "coloredlogs",
     "httpx2",
     "mcp>=2",
@@ -44,7 +45,7 @@ include = ["src/zen_cli", "tests", "README.md", "LICENSE"]
 target-version = "py312"
 line-length = 120
 src = ["src"]
-exclude = ["cli-ref", "src/zen_cli/support/test_utils2.py"]
+exclude = ["cli-ref"]
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
@@ -53,7 +54,6 @@ select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
 python_version = "3.12"
 strict = true
 files = ["src"]
-exclude = ["test_utils2\\.py"]
 
 [[tool.mypy.overrides]]
 module = ["mcp", "mcp.*"]

zen_cli-0.1.8/src/zen_cli/__init__.py

@@ -0,0 +1,14 @@
+"""zen-cli package."""
+
+_httpx_aliased = False
+
+
+def alias_httpx() -> None:
+    """Install httpx2 as httpx. Call before the first HTTP client import."""
+    global _httpx_aliased
+    if _httpx_aliased:
+        return
+    import httpx2
+
+    httpx2.alias_httpx()
+    _httpx_aliased = True

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cli.py

@@ -4,7 +4,7 @@ import sys
 from pathlib import Path
 from typing import Any
 
-import click
+import rich_click as click
 from dotenv import load_dotenv
 from yumako import env
 
@@ -32,11 +32,8 @@ 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 = {
+CONTEXT_SETTINGS: dict[str, Any] = {
     "help_option_names": ["-h", "--help"],
     "max_content_width": 160,
 }
@@ -52,6 +49,7 @@ def _apply_readonly() -> None:
     else:
         is_readonly = bool(is_readonly)
     if is_readonly:
+        from zen_cli.sglib import ez_client
         from zen_cli.util import readonly as readonly_support
 
         ez_client.set_readonly(True, readonly_support.ALLOW_PATHS)
@@ -75,7 +73,7 @@ def _enable_verbose() -> None:
 
 
 def _check_upgrade() -> None:
-    check_flag_from_env = env.bool("HCS_CLI_CHECK_UPGRADE", True)
+    check_flag_from_env = env.bool("ZEN_CLI_CHECK_UPGRADE", True)
     if not check_flag_from_env:
         return
     if os.environ.get("_ZEN_COMPLETE"):
@@ -105,7 +103,7 @@ def _check_upgrade() -> None:
 @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.",
+    help="Check for a new zen-cli version. On by default. Or set ZEN_CLI_CHECK_UPGRADE=false.",
 )
 @click.option(
     "--telemetry/--no-telemetry",
@@ -155,6 +153,9 @@ def cli(
 
         mdc_session.set(mdc)
 
+    from zen_cli.support.recent import install as install_recent
+
+    install_recent()
     _apply_readonly()
     load_commands()
 
@@ -171,6 +172,9 @@ def load_commands() -> None:
 def main() -> None:
     ctxp.init(app_name="zen", config_path=str(_CONFIG_DIR))
     load_dotenv(".env")
+    if not logger.color_enabled():
+        CONTEXT_SETTINGS["color"] = False
+        CONTEXT_SETTINGS["rich_help_config"] = {"color_system": None, "force_terminal": False}
     if os.environ.get("_ZEN_COMPLETE"):
         ctxp.telemetry.disable()
     ctxp.init_cli(main_cli=cli, commands_dir=str(_COMMANDS_DIR))

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/activity/list.py

@@ -3,8 +3,9 @@ from typing import Any
 import click
 
 import zen_cli.sglib.cli_options as cli
-from zen_cli.ctxp import recent, util
+from zen_cli.ctxp import recent
 from zen_cli.service import activity
+from zen_cli.support.activity import format_activity_table
 
 _RESOURCE_TYPES = [
     "ORG",
@@ -28,26 +29,6 @@ _RESOURCE_TYPES = [
     "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
@@ -101,7 +82,7 @@ def _format_activity_table(data: Any) -> Any:
 )
 @cli.sort
 @cli.limit
-@cli.formatter(_format_activity_table)
+@cli.formatter(format_activity_table)
 def list_activities(
     org: str,
     service_name: str,

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/api.py

@@ -2,9 +2,7 @@ from typing import Any
 
 import click
 
-from zen_cli.service import api as zen_api
 from zen_cli.sglib import mdc as mdc_session
-from zen_cli.sglib.client_util import resolve_zds_base_url
 from zen_cli.support.payload import handle_data_input
 
 
@@ -50,21 +48,19 @@ def _build_headers(header: list[str], content_type: str | None) -> dict[str, str
     "--mdc",
     type=str,
     required=False,
-    help="MDC name to use. Only valid when the service is a global service.",
+    help="MDC name.",
 )
 @click.option(
     "--region",
     type=str,
     required=False,
-    help="Regional name to use. Only valid when the service is a regional service.",
+    help="Region name.",
 )
 @click.option(
     "--raise-on-404",
     is_flag=True,
     default=False,
-    help=(
-        "Raise an error on HTTP 404 responses. If not set, returns None on 404. Only valid for GET and DELETE methods."
-    ),
+    help="Raise on HTTP 404.",
 )
 @click.option(
     "--all-pages",
@@ -108,6 +104,9 @@ def api(
     if raise_on_404 and method not in ("GET", "DELETE"):
         raise click.UsageError("The --raise-on-404 option is only applicable for GET and DELETE methods.")
 
+    from zen_cli.service import api as zen_api
+    from zen_cli.sglib.client_util import resolve_zds_base_url
+
     raw_data, json_data = handle_data_input(data_arg, json_arg)
 
     if method in ["GET", "DELETE"] and (raw_data is not None or json_data is not None):

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/auth/details.py

@@ -11,7 +11,7 @@ from zen_cli.support import auth as auth_support
     "--service",
     "-s",
     required=False,
-    help="Get the auth details for a target service. Useful if per-service auth override is configured.",
+    help="Target service.",
 )
 def details(service: str | None) -> Any:
     """Show cached token, JWT claims, and org."""

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/auth/status.py

@@ -10,8 +10,8 @@ from zen_cli.support import auth as auth_support
     "--service",
     "-s",
     required=False,
-    help="Report login status for a target service override.",
+    help="Target service.",
 )
 def status(service: str | None) -> Any:
-    """Show whether you are logged in, the login method, and token TTL in seconds."""
+    """Show whether you are logged in, TTL, and main JWT identity (name, acct, org, roles)."""
     return auth_support.session_status(service)

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/auth/token.py

@@ -10,7 +10,7 @@ from zen_cli.support import auth as auth_support
     "--service",
     "-s",
     required=False,
-    help="Get the access token for a target service. Useful if per-service auth override is configured.",
+    help="Target service.",
 )
 def token(service: str | None) -> Any:
     """Print the current access token."""

zen_cli-0.1.8/src/zen_cli/cmds/completion.py

@@ -0,0 +1,44 @@
+import click
+from click.shell_completion import get_completion_class
+
+_SHELLS = ("bash", "zsh", "fish", "powershell")
+
+
+@click.command()
+@click.argument("shell", type=click.Choice(_SHELLS, case_sensitive=False), metavar="SHELL")
+def completion(shell: str) -> None:
+    """Print a shell completion script for tab-completing zen.
+
+    After the script is loaded, type `zen` and press Tab to complete commands,
+    groups, and flags. Examples: `zen <Tab>`, `zen org <Tab>`, `zen --<Tab>`.
+
+    \b
+    Enable for this session:
+        bash:        eval "$(zen completion bash)"
+        zsh:         eval "$(zen completion zsh)"
+        fish:        zen completion fish | source
+        powershell:  zen completion powershell | Out-String | Invoke-Expression
+
+    \b
+    Make it permanent (open a new terminal afterward):
+        bash:        echo 'eval "$(zen completion bash)"' >> ~/.bashrc
+        zsh:         echo 'eval "$(zen completion zsh)"' >> ~/.zshrc
+        fish:        mkdir -p ~/.config/fish/completions
+                     zen completion fish > ~/.config/fish/completions/zen.fish
+        powershell:  Add the Invoke-Expression line to your $PROFILE
+                     (create it with `New-Item -Force $PROFILE` if missing)
+
+    bash needs the bash-completion package. zsh needs `compinit` in ~/.zshrc
+    (oh-my-zsh and most configs already have it).
+    """
+    ctx = click.get_current_context().find_root()
+    prog_name = ctx.info_name or "zen"
+    complete_var = f"_{prog_name.replace('-', '_').upper()}_COMPLETE"
+    cls = get_completion_class(shell)
+    if cls is None:
+        raise click.UsageError(f"Unsupported shell: {shell}")
+    script = cls(ctx.command, {}, prog_name, complete_var).source()
+    click.echo(script, nl=not script.endswith("\n"))
+
+
+completion.ignore_default_io = True  # type: ignore[attr-defined]

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/credential/create.py

@@ -9,5 +9,5 @@ from zen_cli.support.payload import payload_options, run_create
 @click.command()
 @payload_options
 def create(data_arg: str | None, json_arg: str | None) -> Any:
-    """Create a credential from a JSON payload."""
+    """Create a credential."""
     return run_create("credential", credential.create, data_arg, json_arg)

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/deployment/create.py

@@ -11,7 +11,7 @@ from zen_cli.support.payload import payload_options, run_create
 @cli.org_id
 @payload_options
 def create(org: str, data_arg: str | None, json_arg: str | None) -> Any:
-    """Create an express deployment from a JSON payload."""
+    """Create an express deployment."""
 
     def _create(payload: Any) -> Any:
         return deployment.create(payload, org_id=cli.get_org_id(org))

zen_cli-0.1.8/src/zen_cli/cmds/deployment/list.py

@@ -0,0 +1,19 @@
+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 deployment
+from zen_cli.support.deployment import format_deployment_table
+
+
+@click.command(name="list")
+@cli.org_id
+@cli.limit
+@cli.formatter(format_deployment_table)
+def list_deployments(org: str, **kwargs: Any) -> Any:
+    """List express deployments."""
+    ret = deployment.list(org_id=cli.get_org_id(org), **kwargs)
+    recent.helper.default_list(ret, "deployment")
+    return ret

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/entitlement/create.py

@@ -9,5 +9,5 @@ from zen_cli.support.payload import payload_options, run_create
 @click.command()
 @payload_options
 def create(data_arg: str | None, json_arg: str | None) -> Any:
-    """Create an entitlement from a JSON payload."""
+    """Create an entitlement."""
     return run_create("entitlement", entitlement.create, data_arg, json_arg)

{zen_cli-0.1.6 → zen_cli-0.1.8}/src/zen_cli/cmds/group/create.py

@@ -9,5 +9,5 @@ from zen_cli.support.payload import payload_options, run_create
 @click.command()
 @payload_options
 def create(data_arg: str | None, json_arg: str | None) -> Any:
-    """Create a pool group from a JSON payload."""
+    """Create a pool group."""
     return run_create("group", pool_group.create, data_arg, json_arg)