compshare-cli 0.3.4__tar.gz → 0.3.6__tar.gz

compshare_cli-0.3.6/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: compshare-cli
+Version: 0.3.6
+Summary: Command-line client for CompShare GPU compute
+Author: CompShare
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/BennielAllan/compshare-cli
+Project-URL: Repository, https://github.com/BennielAllan/compshare-cli
+Project-URL: Changelog, https://github.com/BennielAllan/compshare-cli/blob/master/CHANGELOG.md
+Project-URL: Issues, https://github.com/BennielAllan/compshare-cli/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9,>=8.1
+Requires-Dist: pexpect<5,>=4.9; platform_system != "Windows"
+Requires-Dist: rich<15,>=13
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: ucloud-sdk-python3<0.12,>=0.11.103
+Requires-Dist: urllib3<2,>=1.26.18; python_version < "3.10" and platform_system == "Darwin"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: pytest-cov<8,>=5; extra == "dev"
+Requires-Dist: ruff<1,>=0.6; extra == "dev"
+Dynamic: license-file
+
+# CompShare CLI
+
+在终端管理优云智算 GPU 实例、镜像、云盘、US3 挂载和团队资源。
+
+- 交互式创建实例，实时查询规格、库存和价格
+- 支持批量生命周期操作、等待状态和跨地域查询
+- 支持可断线恢复的远程任务、状态查询和增量日志读取
+- 支持社区/自定义镜像、云盘、团队额度与账单
+- 默认中文帮助，可切换英文；所有命令支持 JSON 输出
+- 可通过 `compshare ask` 查询产品使用和计费知识
+- 可通过 `compshare feedback` 反馈 CLI 问题和建议
+
+## 安装
+
+```bash
+pip install compshare-cli
+pip install --upgrade compshare-cli
+```
+
+## 配置
+
+```bash
+compshare config --name default
+```
+
+凭证保存在 `~/.config/compshare/config.json`，支持多个配置：
+
+```bash
+compshare config list
+compshare config use production
+compshare --profile production instance list
+```
+
+也可以使用环境变量：
+
+```bash
+export COMPSHARE_PUBLIC_KEY='...'
+export COMPSHARE_PRIVATE_KEY='...'
+```
+
+CLI 使用统计和反馈与业务 API 一样，通过当前 profile 的凭证签名后发送到
+`https://api.compshare.cn/`；开发环境可使用 `COMPSHARE_INSIGHTS_URL` 覆盖网关地址。
+
+## 快速开始
+
+```bash
+# 查询、创建和查看实例
+compshare instance search --region cn-sh2 --zone cn-sh2-02
+compshare instance create
+compshare instance list --all
+
+# 连接实例
+compshare instance ssh INSTANCE_ID
+
+# 查看帮助
+compshare -h
+compshare instance -h
+```
+
+## 命令概览
+
+```text
+compshare config     API 凭证配置
+compshare feedback   反馈 CLI 问题或建议
+compshare doctor     配置、鉴权、网络与 SSH 环境诊断
+compshare ask        产品使用和计费问答
+compshare instance   GPU 实例、规格、库存、价格和生命周期
+compshare image      平台、自定义、社区及共享镜像
+compshare storage    云盘和 US3 挂载
+compshare team       团队、邀请、成员额度、账单和审计
+```
+
+## Skill
+
+为 Codex、Claude Code、Cursor 等 AI Agent 安装 CompShare CLI Skill：
+
+```bash
+npx skills add compshare-cn/compshare-cli --skill compshare-cli
+```
+
+完整说明见 [CompShare CLI Skill](skills/compshare-cli/SKILL.md)。
+
+## SDK
+
+如需通过 SDK 集成 CompShare API，可参考独立的
+[CompShare Developer Examples](https://github.com/ucloud/compshare-developer-examples) 仓库。
+其中包含 Python、Go、Java、JavaScript 和 PHP 示例，覆盖 API 鉴权、GPU 实例创建、规格配置和状态查询。

compshare_cli-0.3.6/README.md

@@ -0,0 +1,87 @@
+# CompShare CLI
+
+在终端管理优云智算 GPU 实例、镜像、云盘、US3 挂载和团队资源。
+
+- 交互式创建实例，实时查询规格、库存和价格
+- 支持批量生命周期操作、等待状态和跨地域查询
+- 支持可断线恢复的远程任务、状态查询和增量日志读取
+- 支持社区/自定义镜像、云盘、团队额度与账单
+- 默认中文帮助，可切换英文；所有命令支持 JSON 输出
+- 可通过 `compshare ask` 查询产品使用和计费知识
+- 可通过 `compshare feedback` 反馈 CLI 问题和建议
+
+## 安装
+
+```bash
+pip install compshare-cli
+pip install --upgrade compshare-cli
+```
+
+## 配置
+
+```bash
+compshare config --name default
+```
+
+凭证保存在 `~/.config/compshare/config.json`，支持多个配置：
+
+```bash
+compshare config list
+compshare config use production
+compshare --profile production instance list
+```
+
+也可以使用环境变量：
+
+```bash
+export COMPSHARE_PUBLIC_KEY='...'
+export COMPSHARE_PRIVATE_KEY='...'
+```
+
+CLI 使用统计和反馈与业务 API 一样，通过当前 profile 的凭证签名后发送到
+`https://api.compshare.cn/`；开发环境可使用 `COMPSHARE_INSIGHTS_URL` 覆盖网关地址。
+
+## 快速开始
+
+```bash
+# 查询、创建和查看实例
+compshare instance search --region cn-sh2 --zone cn-sh2-02
+compshare instance create
+compshare instance list --all
+
+# 连接实例
+compshare instance ssh INSTANCE_ID
+
+# 查看帮助
+compshare -h
+compshare instance -h
+```
+
+## 命令概览
+
+```text
+compshare config     API 凭证配置
+compshare feedback   反馈 CLI 问题或建议
+compshare doctor     配置、鉴权、网络与 SSH 环境诊断
+compshare ask        产品使用和计费问答
+compshare instance   GPU 实例、规格、库存、价格和生命周期
+compshare image      平台、自定义、社区及共享镜像
+compshare storage    云盘和 US3 挂载
+compshare team       团队、邀请、成员额度、账单和审计
+```
+
+## Skill
+
+为 Codex、Claude Code、Cursor 等 AI Agent 安装 CompShare CLI Skill：
+
+```bash
+npx skills add compshare-cn/compshare-cli --skill compshare-cli
+```
+
+完整说明见 [CompShare CLI Skill](skills/compshare-cli/SKILL.md)。
+
+## SDK
+
+如需通过 SDK 集成 CompShare API，可参考独立的
+[CompShare Developer Examples](https://github.com/ucloud/compshare-developer-examples) 仓库。
+其中包含 Python、Go、Java、JavaScript 和 PHP 示例，覆盖 API 鉴权、GPU 实例创建、规格配置和状态查询。

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/__init__.py

@@ -1,3 +1,3 @@
 """CompShare command-line client."""
 
-__version__ = "0.3.4"
+__version__ = "0.3.6"

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/cli.py

@@ -506,16 +506,45 @@ def _requested_language(argv: List[str]) -> Optional[str]:
     return requested
 
 
+def _requested_profile(argv: List[str]) -> Optional[str]:
+    """Return the root --profile value, if present."""
+    index = 0
+    while index < len(argv):
+        option = argv[index]
+        if option == "--profile":
+            return argv[index + 1] if index + 1 < len(argv) else None
+        if option.startswith("--profile="):
+            return option.split("=", 1)[1] or None
+        if option in {"--lang"}:
+            index += 2
+            continue
+        if option.startswith("--lang=") or option in {
+            "--json",
+            "--show-sensitive",
+            "--version",
+            "-h",
+            "--help",
+        }:
+            index += 1
+            continue
+        if not option.startswith("-"):
+            break
+        index += 1
+    return None
+
+
 def main(args: Optional[List[str]] = None) -> None:
     original_argv = list(sys.argv[1:] if args is None else args)
     argv = list(original_argv)
     if not argv:
         argv = ["-h"]
     telemetry_command: Optional[str] = None
+    telemetry_profile: Optional[str] = None
     json_output = _global_flag_requested(argv, "--json")
     show_sensitive = _global_flag_requested(argv, "--show-sensitive")
     try:
         argv = _normalize_global_options(argv)
+        telemetry_profile = _requested_profile(argv)
         requested_language = _requested_language(argv)
         if requested_language is None:
             language = configured_language()
@@ -547,7 +576,10 @@ def main(args: Optional[List[str]] = None) -> None:
         raise SystemExit(1) from error
     finally:
         if telemetry_command:
-            record_command(telemetry_command)
+            if telemetry_profile is None:
+                record_command(telemetry_command)
+            else:
+                record_command(telemetry_command, telemetry_profile)
     if isinstance(result, int) and result:
         raise SystemExit(result)
 

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/commands/feedback.py

@@ -14,7 +14,7 @@ class FeedbackCategory(str, Enum):
 
 
 def run(state: Runtime, category: FeedbackCategory, message: str) -> None:
-    response = submit_feedback(category.value, message)
+    response = submit_feedback(state.profile, category.value, message)
     Renderer(state.json_output, state.show_sensitive).success(
         tr("Thank you for your feedback."), response
     )

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/i18n.py

@@ -718,9 +718,7 @@ ZH_TRANSLATIONS: Dict[str, str] = {
     "Feedback service is not configured; set {variable}.": (
         "反馈服务尚未配置，请设置 {variable}。"
     ),
-    "Insights service rejected the request with HTTP {status}.": (
-        "数据服务拒绝了请求，HTTP 状态码为 {status}。"
-    ),
+    "Insights service rejected the request: {detail}": "数据服务拒绝了请求：{detail}",
     "Unable to reach the insights service.": "无法连接数据服务。",
     "Insights service returned an invalid response.": "数据服务返回了无效响应。",
     "Thank you for your feedback.": "感谢反馈。",

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/insights.py

@@ -7,16 +7,21 @@ import platform
 import subprocess
 import sys
 from datetime import datetime, timezone
-from typing import Any, Dict
-from urllib import error as urlerror
-from urllib import parse, request
+from typing import Any, Dict, Optional
+from urllib import parse
+
+from ucloud.core import exc as ucloud_exc
 
 from compshare_cli import __version__
+from compshare_cli.config import ConfigStore, Profile
 from compshare_cli.errors import CLIError
 from compshare_cli.i18n import tr
+from compshare_cli.sdk import CompShareSDK
 
 ENDPOINT_ENV = "COMPSHARE_INSIGHTS_URL"
-DEFAULT_ENDPOINT = "http://117.50.180.139:27299"
+DEFAULT_ENDPOINT = "https://api.compshare.cn"
+EVENT_ACTION = "CreateCSCLIEvent"
+FEEDBACK_ACTION = "CreateCSCLIFeedback"
 
 
 def now() -> str:
@@ -28,18 +33,21 @@ def os_name() -> str:
     return value or sys.platform.lower()
 
 
-def record_command(command: str) -> None:
+def record_command(command: str, profile_name: Optional[str] = None) -> None:
     """Report a command in a detached process without delaying or affecting the CLI."""
     if not _base_url():
         return
-    payload = {
-        "command": command,
-        "cli_version": __version__,
-        "os": os_name(),
-        "time": now(),
+    document = {
+        "profile_name": profile_name,
+        "payload": {
+            "Command": command,
+            "CLIVersion": __version__,
+            "OS": os_name(),
+            "OccurredAt": now(),
+        },
     }
     encoded = base64.urlsafe_b64encode(
-        json.dumps(payload, ensure_ascii=False, separators=(",", ":")).encode("utf-8")
+        json.dumps(document, ensure_ascii=False, separators=(",", ":")).encode("utf-8")
     ).decode("ascii")
     kwargs: Dict[str, Any] = {
         "stdin": subprocess.DEVNULL,
@@ -60,7 +68,11 @@ def record_command(command: str) -> None:
         pass
 
 
-def submit_feedback(category: str, message: str) -> Dict[str, Any]:
+def submit_feedback(
+    profile: Profile,
+    category: str,
+    message: str,
+) -> Dict[str, Any]:
     if category not in {"bug", "suggest"}:
         raise CLIError(tr("Feedback category must be bug or suggest."))
     normalized = message.strip()
@@ -75,17 +87,33 @@ def submit_feedback(category: str, message: str) -> Dict[str, Any]:
                 variable=ENDPOINT_ENV,
             )
         )
-    return _post(
-        "/v1/feedback",
-        {
-            "category": category,
-            "message": normalized,
-            "cli_version": __version__,
-            "os": os_name(),
-            "time": now(),
-        },
-        timeout=5.0,
-    )
+    try:
+        response = _invoke(
+            profile,
+            FEEDBACK_ACTION,
+            {
+                "Category": category,
+                "Content": normalized,
+                "CLIVersion": __version__,
+                "OS": os_name(),
+                "OccurredAt": now(),
+            },
+        )
+        feedback_id = response.get("Id") if isinstance(response, dict) else None
+        if not feedback_id:
+            raise ValueError("missing feedback ID")
+        return {"ok": True, "id": feedback_id}
+    except ucloud_exc.RetCodeException as error:
+        raise CLIError(
+            tr(
+                "Insights service rejected the request: {detail}",
+                detail=error.message or str(error.code),
+            )
+        ) from error
+    except (ucloud_exc.UCloudException, TimeoutError, OSError) as error:
+        raise CLIError(tr("Unable to reach the insights service.")) from error
+    except Exception as error:
+        raise CLIError(tr("Insights service returned an invalid response.")) from error
 
 
 def _base_url() -> str:
@@ -96,43 +124,22 @@ def _base_url() -> str:
     return value if parsed.scheme in {"http", "https"} and parsed.netloc else ""
 
 
-def _post(path: str, payload: Dict[str, Any], *, timeout: float) -> Dict[str, Any]:
-    body = json.dumps(payload, ensure_ascii=False, separators=(",", ":")).encode("utf-8")
-    req = request.Request(
-        f"{_base_url()}{path}",
-        data=body,
-        headers={
-            "Accept": "application/json",
-            "Content-Type": "application/json",
-            "User-Agent": f"compshare-cli/{__version__}",
-        },
-        method="POST",
-    )
-    try:
-        with request.urlopen(req, timeout=timeout) as response:
-            content = response.read()
-    except urlerror.HTTPError as error:
-        raise CLIError(
-            tr("Insights service rejected the request with HTTP {status}.", status=error.code)
-        ) from error
-    except (urlerror.URLError, TimeoutError, OSError) as error:
-        raise CLIError(tr("Unable to reach the insights service.")) from error
-    if not content:
-        return {"ok": True}
-    try:
-        result = json.loads(content.decode("utf-8"))
-    except (UnicodeDecodeError, json.JSONDecodeError) as error:
-        raise CLIError(tr("Insights service returned an invalid response.")) from error
-    if not isinstance(result, dict):
-        raise CLIError(tr("Insights service returned an invalid response."))
-    return result
+def _invoke(profile: Profile, action: str, payload: Dict[str, Any]) -> Dict[str, Any]:
+    return CompShareSDK(profile, base_url=_base_url()).invoke(action, payload)
 
 
 def _send_event(encoded: str) -> None:
     try:
-        payload = json.loads(base64.urlsafe_b64decode(encoded.encode("ascii")).decode("utf-8"))
-        if isinstance(payload, dict) and _base_url():
-            _post("/v1/events", payload, timeout=3.0)
+        document = json.loads(base64.urlsafe_b64decode(encoded.encode("ascii")).decode("utf-8"))
+        if not isinstance(document, dict) or not _base_url():
+            return
+        payload = document.get("payload")
+        if not isinstance(payload, dict):
+            return
+        raw_profile_name = document.get("profile_name")
+        profile_name = str(raw_profile_name) if raw_profile_name else None
+        profile = ConfigStore().load_profile(profile_name)
+        _invoke(profile, EVENT_ACTION, payload)
     except Exception:
         pass
 

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/location.py

@@ -77,11 +77,7 @@ def locate_disk(
     zone = str(disk.get("Zone") or "")
     locations = supported_locations(state, request_region=request_region)
     location = next(
-        (
-            item
-            for item in locations
-            if str(item.get("Zone") or "") == zone and item.get("Region")
-        ),
+        (item for item in locations if str(item.get("Zone") or "") == zone and item.get("Region")),
         None,
     )
     if location is None:
@@ -95,8 +91,6 @@ def locate_disk(
     region = str(location["Region"])
     mount_instance = disk.get("MountInstance")
     host = (
-        {"UHostId": str(mount_instance), "Region": region, "Zone": zone}
-        if mount_instance
-        else None
+        {"UHostId": str(mount_instance), "Region": region, "Zone": zone} if mount_instance else None
     )
     return region, zone, host, disk

{compshare_cli-0.3.4 → compshare_cli-0.3.6}/src/compshare_cli/sdk.py

@@ -17,13 +17,21 @@ class CompShareSDK:
     lag behind the public API and silently discard newer fields.
     """
 
-    def __init__(self, profile: Profile, region: Optional[str] = None) -> None:
+    def __init__(
+        self,
+        profile: Profile,
+        region: Optional[str] = None,
+        base_url: Optional[str] = None,
+    ) -> None:
         logger = logging.getLogger("compshare_cli.ucloud")
         logger.handlers.clear()
         logger.addHandler(logging.NullHandler())
         logger.setLevel(logging.CRITICAL)
         logger.propagate = False
-        self._service = Client(profile.sdk_config(region), logger=logger).ucompshare()
+        config = profile.sdk_config(region)
+        if base_url is not None:
+            config["base_url"] = base_url
+        self._service = Client(config, logger=logger).ucompshare()
 
     def invoke(self, action: str, params: Dict[str, Any]) -> Dict[str, Any]:
         return self._service.invoke(action, params)

compshare_cli-0.3.6/src/compshare_cli.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: compshare-cli
+Version: 0.3.6
+Summary: Command-line client for CompShare GPU compute
+Author: CompShare
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/BennielAllan/compshare-cli
+Project-URL: Repository, https://github.com/BennielAllan/compshare-cli
+Project-URL: Changelog, https://github.com/BennielAllan/compshare-cli/blob/master/CHANGELOG.md
+Project-URL: Issues, https://github.com/BennielAllan/compshare-cli/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9,>=8.1
+Requires-Dist: pexpect<5,>=4.9; platform_system != "Windows"
+Requires-Dist: rich<15,>=13
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: ucloud-sdk-python3<0.12,>=0.11.103
+Requires-Dist: urllib3<2,>=1.26.18; python_version < "3.10" and platform_system == "Darwin"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: pytest-cov<8,>=5; extra == "dev"
+Requires-Dist: ruff<1,>=0.6; extra == "dev"
+Dynamic: license-file
+
+# CompShare CLI
+
+在终端管理优云智算 GPU 实例、镜像、云盘、US3 挂载和团队资源。
+
+- 交互式创建实例，实时查询规格、库存和价格
+- 支持批量生命周期操作、等待状态和跨地域查询
+- 支持可断线恢复的远程任务、状态查询和增量日志读取
+- 支持社区/自定义镜像、云盘、团队额度与账单
+- 默认中文帮助，可切换英文；所有命令支持 JSON 输出
+- 可通过 `compshare ask` 查询产品使用和计费知识
+- 可通过 `compshare feedback` 反馈 CLI 问题和建议
+
+## 安装
+
+```bash
+pip install compshare-cli
+pip install --upgrade compshare-cli
+```
+
+## 配置
+
+```bash
+compshare config --name default
+```
+
+凭证保存在 `~/.config/compshare/config.json`，支持多个配置：
+
+```bash
+compshare config list
+compshare config use production
+compshare --profile production instance list
+```
+
+也可以使用环境变量：
+
+```bash
+export COMPSHARE_PUBLIC_KEY='...'
+export COMPSHARE_PRIVATE_KEY='...'
+```
+
+CLI 使用统计和反馈与业务 API 一样，通过当前 profile 的凭证签名后发送到
+`https://api.compshare.cn/`；开发环境可使用 `COMPSHARE_INSIGHTS_URL` 覆盖网关地址。
+
+## 快速开始
+
+```bash
+# 查询、创建和查看实例
+compshare instance search --region cn-sh2 --zone cn-sh2-02
+compshare instance create
+compshare instance list --all
+
+# 连接实例
+compshare instance ssh INSTANCE_ID
+
+# 查看帮助
+compshare -h
+compshare instance -h
+```
+
+## 命令概览
+
+```text
+compshare config     API 凭证配置
+compshare feedback   反馈 CLI 问题或建议
+compshare doctor     配置、鉴权、网络与 SSH 环境诊断
+compshare ask        产品使用和计费问答
+compshare instance   GPU 实例、规格、库存、价格和生命周期
+compshare image      平台、自定义、社区及共享镜像
+compshare storage    云盘和 US3 挂载
+compshare team       团队、邀请、成员额度、账单和审计
+```
+
+## Skill
+
+为 Codex、Claude Code、Cursor 等 AI Agent 安装 CompShare CLI Skill：
+
+```bash
+npx skills add compshare-cn/compshare-cli --skill compshare-cli
+```
+
+完整说明见 [CompShare CLI Skill](skills/compshare-cli/SKILL.md)。
+
+## SDK
+
+如需通过 SDK 集成 CompShare API，可参考独立的
+[CompShare Developer Examples](https://github.com/ucloud/compshare-developer-examples) 仓库。
+其中包含 Python、Go、Java、JavaScript 和 PHP 示例，覆盖 API 鉴权、GPU 实例创建、规格配置和状态查询。