web-presentation-cli 0.1.0__tar.gz

web_presentation_cli-0.1.0/.gitignore

@@ -0,0 +1,29 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage*
+htmlcov/
+dist/
+build/
+*.egg-info/
+
+# Local configuration and secrets
+.env
+.env.*
+!.env.example
+!.env.*.example
+
+# Agent and tool caches
+.codex/
+.tmp/
+
+# Editors and OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db

web_presentation_cli-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.5
+Name: web-presentation-cli
+Version: 0.1.0
+Summary: Web Presentation CLI - 面向 AI 演示文稿创作平台的命令行与 Agent 工具包
+Project-URL: Homepage, https://github.com/LLMxPM/web-presentation-agent-kit
+Project-URL: Repository, https://github.com/LLMxPM/web-presentation-agent-kit
+Project-URL: Issues, https://github.com/LLMxPM/web-presentation-agent-kit/issues
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1.7
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: rich>=13.7.0
+Description-Content-Type: text/markdown
+
+# Web Presentation CLI (`wp`)
+
+面向 `web-presentation` AI 演示文稿创作平台的官方命令行与 Agent 工具包。
+
+External API 路径、Scope、错误码、幂等和异步任务语义以主仓 [External Agent API v1 契约](https://github.com/LLMxPM/web-presentation/blob/main/docs/developer/reference/external-agent-api.md) 为准；CLI 命令和参数以本仓 `wp --help` 与 CLI 实施文档为准。
+
+## 安装与快速开始
+
+```bash
+# 从 PyPI 安装公开发行版
+uv tool install web-presentation-cli
+# 或使用 pipx
+pipx install web-presentation-cli
+
+# 在 agent-kit 仓库根目录安装 CLI
+uv pip install -e ./packages/cli
+
+# 登录并绑定 PAT 令牌
+wp login --token wp_pat_xxxxxxxx.yyyyyyyyyyyyyyyy
+# 生产环境可指定 Backend 根地址（不要包含 /api/v1）
+wp login --endpoint https://api.example.com --token wp_pat_xxxxxxxx.yyyyyyyyyyyyyyyy
+
+# 检查环境与连通性
+wp doctor
+
+# 查看授权的工作空间并切换当前工作空间
+wp workspace list
+wp workspace use <workspace_id>
+
+# 查看并切换默认 Profile（Profile 保存 Backend 地址、PAT 和默认工作空间）
+wp profile list
+wp profile use production
+
+# 常用操作
+wp system health
+wp project list
+wp project configuration get <project_id>
+wp page list --project-id <project_id>
+wp page dependencies <page_id>
+wp component list --scope suggested --project-id <project_id>
+wp asset content get <asset_id>
+wp theme list
+wp style list
+wp --json guide list
+wp job wait <job_id>
+```
+
+复杂写入参数使用 `--payload-file`、`--edits-file`、`--content-file`、`--route-file` 和 `--ids-file`。Build、产物下载、Agent 运行、图片能力、Restore 和 MCP 不属于当前 CLI。
+
+写入命令支持 `--idempotency-key <key>`；网络超时后需要重放同一业务请求时复用原 key，不要把同一个 key 用于不同请求。

web_presentation_cli-0.1.0/README.md

@@ -0,0 +1,50 @@
+# Web Presentation CLI (`wp`)
+
+面向 `web-presentation` AI 演示文稿创作平台的官方命令行与 Agent 工具包。
+
+External API 路径、Scope、错误码、幂等和异步任务语义以主仓 [External Agent API v1 契约](https://github.com/LLMxPM/web-presentation/blob/main/docs/developer/reference/external-agent-api.md) 为准；CLI 命令和参数以本仓 `wp --help` 与 CLI 实施文档为准。
+
+## 安装与快速开始
+
+```bash
+# 从 PyPI 安装公开发行版
+uv tool install web-presentation-cli
+# 或使用 pipx
+pipx install web-presentation-cli
+
+# 在 agent-kit 仓库根目录安装 CLI
+uv pip install -e ./packages/cli
+
+# 登录并绑定 PAT 令牌
+wp login --token wp_pat_xxxxxxxx.yyyyyyyyyyyyyyyy
+# 生产环境可指定 Backend 根地址（不要包含 /api/v1）
+wp login --endpoint https://api.example.com --token wp_pat_xxxxxxxx.yyyyyyyyyyyyyyyy
+
+# 检查环境与连通性
+wp doctor
+
+# 查看授权的工作空间并切换当前工作空间
+wp workspace list
+wp workspace use <workspace_id>
+
+# 查看并切换默认 Profile（Profile 保存 Backend 地址、PAT 和默认工作空间）
+wp profile list
+wp profile use production
+
+# 常用操作
+wp system health
+wp project list
+wp project configuration get <project_id>
+wp page list --project-id <project_id>
+wp page dependencies <page_id>
+wp component list --scope suggested --project-id <project_id>
+wp asset content get <asset_id>
+wp theme list
+wp style list
+wp --json guide list
+wp job wait <job_id>
+```
+
+复杂写入参数使用 `--payload-file`、`--edits-file`、`--content-file`、`--route-file` 和 `--ids-file`。Build、产物下载、Agent 运行、图片能力、Restore 和 MCP 不属于当前 CLI。
+
+写入命令支持 `--idempotency-key <key>`；网络超时后需要重放同一业务请求时复用原 key，不要把同一个 key 用于不同请求。

web_presentation_cli-0.1.0/hatch_build.py

@@ -0,0 +1,21 @@
+"""文件功能：为 CLI 的 editable 安装映射共享 API Client 源码。"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    """在本地 editable 构建时，把同仓 API Client 映射到 CLI 环境。"""
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        """为 editable wheel 注入跨目录 API Client，正式发行包沿用标准打包配置。"""
+
+        if version != "editable":
+            return
+
+        api_client_source = Path(self.root).parent / "api-client" / "src" / "wp_api_client"
+        build_data["force_include_editable"] = {str(api_client_source): "wp_api_client"}

web_presentation_cli-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "web-presentation-cli"
+version = "0.1.0"
+description = "Web Presentation CLI - 面向 AI 演示文稿创作平台的命令行与 Agent 工具包"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "click>=8.1.7",
+    "httpx>=0.27.0",
+    "rich>=13.7.0",
+    "pydantic>=2.7.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/LLMxPM/web-presentation-agent-kit"
+Repository = "https://github.com/LLMxPM/web-presentation-agent-kit"
+Issues = "https://github.com/LLMxPM/web-presentation-agent-kit/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[project.scripts]
+wp = "wp.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/wp"]
+
+[tool.hatch.build.targets.sdist.force-include]
+"../api-client/src/wp_api_client" = "src/wp_api_client"
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/wp_api_client" = "wp_api_client"
+
+[tool.hatch.build.targets.wheel.hooks.custom]
+path = "hatch_build.py"
+
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

web_presentation_cli-0.1.0/src/wp/__init__.py

@@ -0,0 +1,3 @@
+"""Web Presentation 官方命令行工具包。"""
+
+__version__ = "0.1.0"

web_presentation_cli-0.1.0/src/wp/cli.py

@@ -0,0 +1,68 @@
+"""文件功能：CLI 总入口，注册全局选项与全部资源子命令。"""
+
+from __future__ import annotations
+
+import click
+
+from wp import __version__
+from wp.commands.asset import asset_group
+from wp.commands.auth import login_cmd, logout_cmd, whoami_cmd
+from wp.commands.component import component_group
+from wp.commands.catalog import font_group, runtime_kit_group
+from wp.commands.doctor import doctor_cmd
+from wp.commands.job import job_group
+from wp.commands.page import page_group
+from wp.commands.profile import profile_group
+from wp.commands.project import project_group
+from wp.commands.style import style_group
+from wp.commands.theme import theme_group
+from wp.commands.workspace import workspace_group
+from wp.commands.system import guide_group, standards_group, system_group
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="wp")
+@click.option(
+    "--json",
+    "as_json",
+    is_flag=True,
+    help="让支持表格视图的命令输出 JSON；复杂响应默认也输出 JSON。",
+)
+@click.option("--profile", help="指定使用的 Profile 名称 (默认 default)")
+@click.option("--workspace", "-w", "workspace_id", type=int, help="覆盖当前操作的目标工作空间 ID")
+@click.pass_context
+def main(ctx: click.Context, as_json: bool, profile: str | None, workspace_id: int | None) -> None:
+    """Web Presentation 官方命令行工具 (wp) - 面向 AI 演示文稿创作平台。"""
+
+    ctx.ensure_object(dict)
+    ctx.obj["as_json"] = as_json
+    ctx.obj["profile"] = profile
+    ctx.obj["workspace_id"] = workspace_id
+
+
+# 注册认证与系统命令
+main.add_command(login_cmd)
+main.add_command(logout_cmd)
+main.add_command(whoami_cmd)
+main.add_command(doctor_cmd)
+main.add_command(profile_group)
+main.add_command(system_group)
+main.add_command(standards_group)
+main.add_command(guide_group)
+main.add_command(runtime_kit_group)
+main.add_command(font_group)
+
+
+# 注册各实体资源命令组
+main.add_command(workspace_group)
+main.add_command(project_group)
+main.add_command(page_group)
+main.add_command(component_group)
+main.add_command(asset_group)
+main.add_command(theme_group)
+main.add_command(style_group)
+main.add_command(job_group)
+
+
+if __name__ == "__main__":
+    main()

web_presentation_cli-0.1.0/src/wp/client.py

@@ -0,0 +1,27 @@
+"""文件功能：提供 CLI 对共享 External API v1 客户端的 Profile 适配。"""
+
+from __future__ import annotations
+
+from wp.config import ProfileConfig
+from wp_api_client import ApiClient as SharedApiClient, ApiClientError
+
+
+class ApiClient(SharedApiClient):
+    """把 CLI ProfileConfig 适配为共享 API Client。"""
+
+    def __init__(
+        self,
+        profile: ProfileConfig,
+        workspace_id: int | None = None,
+        idempotency_key: str | None = None,
+    ) -> None:
+        super().__init__(
+            endpoint=profile.endpoint,
+            token=profile.token,
+            workspace_id=workspace_id or profile.default_workspace_id,
+            user_agent="web-presentation-cli/0.1.0",
+            idempotency_key=idempotency_key,
+        )
+
+
+__all__ = ["ApiClient", "ApiClientError"]

web_presentation_cli-0.1.0/src/wp/commands/__init__.py

@@ -0,0 +1 @@
+"""CLI 子命令模块集合。"""

web_presentation_cli-0.1.0/src/wp/commands/asset.py

@@ -0,0 +1,218 @@
+"""文件功能：提供工作空间资源的查询、上传、文本内容、复制、更新与归档命令。"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+from wp.client import ApiClientError
+from wp.commands.common import (
+    confirm_archive,
+    get_client,
+    handle_api_error,
+    idempotency_key_option,
+    output_result,
+    read_json_file,
+    read_text_file,
+    require_array,
+    require_ids,
+    require_object,
+)
+from wp.formatter import print_table
+
+
+ASSET_TYPES = ["image", "icon", "font", "video", "drawio", "mermaid", "chart", "formula"]
+
+
+@click.group("asset")
+def asset_group() -> None:
+    """工作空间静态资源管理。"""
+
+
+@asset_group.command("list")
+@click.option("--page", default=1, type=int)
+@click.option("--page-size", default=50, type=int)
+@click.option("--type", "asset_type", type=click.Choice(ASSET_TYPES))
+@click.option("--keyword")
+@click.pass_context
+def list_assets_cmd(ctx: click.Context, page: int, page_size: int, asset_type: str | None, keyword: str | None) -> None:
+    """查询工作空间资源。"""
+
+    params = {"page": page, "page_size": page_size, "asset_type": asset_type, "keyword": keyword}
+    try:
+        result = get_client(ctx).get("/assets", params={key: value for key, value in params.items() if value is not None})
+        if ctx.obj.get("as_json"):
+            output_result(ctx, result)
+            return
+        rows = [[item.get("id"), item.get("name", "-"), item.get("asset_type", "-"), item.get("status", "-")] for item in result.get("items", [])]
+        print_table("资源列表", ["ID", "名称", "类型", "状态"], rows)
+    except ApiClientError as err:
+        handle_api_error("获取资源列表失败", err)
+
+
+@asset_group.command("get")
+@click.argument("asset_id", type=int)
+@click.pass_context
+def get_asset_cmd(ctx: click.Context, asset_id: int) -> None:
+    """获取资源详情。"""
+
+    try:
+        output_result(ctx, get_client(ctx).get(f"/assets/{asset_id}"))
+    except ApiClientError as err:
+        handle_api_error("获取资源详情失败", err)
+
+
+@asset_group.command("upload")
+@click.argument("file_path", type=click.Path(exists=True, dir_okay=False))
+@click.option("--type", "asset_type", type=click.Choice(ASSET_TYPES), required=True)
+@click.option("--name")
+@click.option("--description")
+@idempotency_key_option
+@click.pass_context
+def upload_asset_cmd(ctx: click.Context, file_path: str, asset_type: str, name: str | None, description: str | None) -> None:
+    """上传二进制或图片资源。"""
+
+    path = Path(file_path)
+    try:
+        with path.open("rb") as file_obj:
+            result = get_client(ctx).upload(
+                "/assets",
+                files={"file": (path.name, file_obj)},
+                data={"asset_type": asset_type, "name": name or path.stem, "description": description},
+            )
+        output_result(ctx, result)
+    except ApiClientError as err:
+        handle_api_error("上传资源失败", err)
+
+
+@asset_group.command("create")
+@click.option("--payload-file", type=click.Path(exists=True, dir_okay=False), required=True)
+@click.option("--content-file", type=click.Path(exists=True, dir_okay=False), help="覆盖 JSON 中 content 的文本文件")
+@idempotency_key_option
+@click.pass_context
+def create_asset_cmd(ctx: click.Context, payload_file: str, content_file: str | None) -> None:
+    """创建文本内容资源。"""
+
+    payload = require_object(read_json_file(payload_file, label="资源创建载荷"), label="资源创建载荷")
+    if content_file:
+        payload["content"] = read_text_file(content_file, label="资源内容")
+    try:
+        output_result(ctx, get_client(ctx).post("/assets/content", json_data=payload))
+    except ApiClientError as err:
+        handle_api_error("创建文本资源失败", err)
+
+
+@asset_group.group("content")
+def asset_content_group() -> None:
+    """可编辑文本资源内容。"""
+
+
+@asset_content_group.command("get")
+@click.argument("asset_id", type=int)
+@click.pass_context
+def get_asset_content_cmd(ctx: click.Context, asset_id: int) -> None:
+    """读取资源文本内容。"""
+
+    try:
+        output_result(ctx, get_client(ctx).get(f"/assets/{asset_id}/content"))
+    except ApiClientError as err:
+        handle_api_error("读取资源内容失败", err)
+
+
+@asset_content_group.command("update")
+@click.argument("asset_id", type=int)
+@click.option("--content-file", type=click.Path(exists=True, dir_okay=False), required=True)
+@click.option("--change-note")
+@idempotency_key_option
+@click.pass_context
+def update_asset_content_cmd(ctx: click.Context, asset_id: int, content_file: str, change_note: str | None) -> None:
+    """写入资源文本内容。"""
+
+    try:
+        output_result(ctx, get_client(ctx).put(f"/assets/{asset_id}/content", json_data={"content": read_text_file(content_file, label="资源内容"), "change_note": change_note}))
+    except ApiClientError as err:
+        handle_api_error("更新资源内容失败", err)
+
+
+@asset_content_group.command("preview")
+@click.argument("asset_id", type=int)
+@click.option("--content-file", type=click.Path(exists=True, dir_okay=False), required=True)
+@click.pass_context
+def preview_asset_content_cmd(ctx: click.Context, asset_id: int, content_file: str) -> None:
+    """预览资源文本内容差异。"""
+
+    try:
+        output_result(ctx, get_client(ctx).post(f"/assets/{asset_id}/content/preview", json_data={"content": read_text_file(content_file, label="资源内容")}, idempotent=False))
+    except ApiClientError as err:
+        handle_api_error("预览资源内容失败", err)
+
+
+@asset_group.group("tags")
+def asset_tags_group() -> None:
+    """资源标签。"""
+
+
+@asset_tags_group.command("list")
+@click.option("--type", "asset_type", type=click.Choice(ASSET_TYPES))
+@click.pass_context
+def list_asset_tags_cmd(ctx: click.Context, asset_type: str | None) -> None:
+    """列出工作空间资源标签。"""
+
+    try:
+        params = {"asset_type": asset_type} if asset_type else None
+        output_result(ctx, get_client(ctx).get("/assets/tags", params=params))
+    except ApiClientError as err:
+        handle_api_error("获取资源标签失败", err)
+
+
+@asset_group.command("update")
+@click.argument("asset_id", type=int)
+@click.option("--payload-file", type=click.Path(exists=True, dir_okay=False), required=True)
+@idempotency_key_option
+@click.pass_context
+def update_asset_cmd(ctx: click.Context, asset_id: int, payload_file: str) -> None:
+    """更新资源元数据。"""
+
+    try:
+        output_result(ctx, get_client(ctx).patch(f"/assets/{asset_id}", json_data=require_object(read_json_file(payload_file, label="资源更新载荷"), label="资源更新载荷")))
+    except ApiClientError as err:
+        handle_api_error("更新资源失败", err)
+
+
+@asset_group.command("copy")
+@click.argument("asset_id", type=int)
+@click.option("--payload-file", type=click.Path(exists=True, dir_okay=False), required=True)
+@idempotency_key_option
+@click.pass_context
+def copy_asset_cmd(ctx: click.Context, asset_id: int, payload_file: str) -> None:
+    """复制资源。"""
+
+    try:
+        output_result(ctx, get_client(ctx).post(f"/assets/{asset_id}/copy", json_data=require_object(read_json_file(payload_file, label="资源复制载荷"), label="资源复制载荷")))
+    except ApiClientError as err:
+        handle_api_error("复制资源失败", err)
+
+
+@asset_group.command("archive")
+@click.argument("asset_id", type=int, required=False)
+@click.option("--ids-file", type=click.Path(exists=True, dir_okay=False))
+@click.option("--yes", is_flag=True)
+@idempotency_key_option
+@click.pass_context
+def archive_asset_cmd(ctx: click.Context, asset_id: int | None, ids_file: str | None, yes: bool) -> None:
+    """归档单个或一批资源。"""
+
+    try:
+        client = get_client(ctx)
+        if ids_file:
+            ids = require_ids(read_json_file(ids_file, label="归档 ID"))
+            confirm_archive(ids, yes=yes, label="资源")
+            output_result(ctx, client.post("/assets/batch-archive", json_data={"ids": ids}))
+            return
+        if asset_id is None:
+            raise click.UsageError("必须提供 asset_id 或 --ids-file。")
+        confirm_archive([asset_id], yes=yes, label="资源")
+        output_result(ctx, client.post(f"/assets/{asset_id}/archive"))
+    except ApiClientError as err:
+        handle_api_error("归档资源失败", err)

web_presentation_cli-0.1.0/src/wp/commands/auth.py

@@ -0,0 +1,98 @@
+"""文件功能：处理 CLI 用户登录、PAT 凭证持久化与身份检查。"""
+
+from __future__ import annotations
+
+import click
+
+from wp.client import ApiClient, ApiClientError
+from wp.config import get_profile, load_config, save_config
+from wp.formatter import print_error, print_json, print_success, print_table
+
+
+@click.command("login")
+@click.option("--token", "-t", required=True, prompt=True, hide_input=True, help="个人访问令牌 (PAT)")
+@click.option("--endpoint", "-e", help="Backend 服务地址 (默认 http://127.0.0.1:8000)")
+@click.pass_context
+def login_cmd(ctx: click.Context, token: str, endpoint: str | None) -> None:
+    """登录并保存个人访问令牌 (PAT)。"""
+
+    cfg = load_config()
+    profile = get_profile(cfg, ctx.obj.get("profile"))
+    if endpoint:
+        profile.endpoint = endpoint
+    profile.token = token.strip()
+
+    client = ApiClient(profile)
+    try:
+        workspaces = client.get("/workspaces")
+        if workspaces:
+            profile.default_workspace_id = workspaces[0]["id"]
+        save_config(cfg)
+        print_success(f"登录成功！已连接到 {profile.endpoint}，授权工作空间数: {len(workspaces)}")
+    except ApiClientError as err:
+        print_error(f"PAT 验证失败: {err.message}", code=err.code)
+        raise SystemExit(1)
+
+
+@click.command("logout")
+@click.pass_context
+def logout_cmd(ctx: click.Context) -> None:
+    """清除当前 Profile 的访问令牌。"""
+
+    cfg = load_config()
+    profile = get_profile(cfg, ctx.obj.get("profile"))
+    profile.token = None
+    profile.default_workspace_id = None
+    save_config(cfg)
+    print_success("已安全清除本地保存的访问令牌。")
+
+
+@click.command("whoami")
+@click.pass_context
+def whoami_cmd(ctx: click.Context) -> None:
+    """检查当前认证状态与权限能力。"""
+
+    cfg = load_config()
+    profile = get_profile(cfg, ctx.obj.get("profile"))
+    client = ApiClient(profile, workspace_id=ctx.obj.get("workspace_id"))
+
+    try:
+        identity = client.get("/auth/whoami")
+        workspaces = identity.get("workspaces", [])
+        if ctx.obj.get("as_json"):
+            print_json({"endpoint": profile.endpoint, **identity})
+            return
+
+        user = identity.get("user") or {}
+        print_success(
+            f"当前环境: [bold]{profile.endpoint}[/bold]，"
+            f"用户: [bold]{user.get('display_name') or user.get('username') or '-'}[/bold]"
+        )
+        print_table(
+            title="当前身份",
+            columns=["字段", "值"],
+            rows=[
+                ["用户 ID", user.get("id")],
+                ["用户名", user.get("username")],
+                ["角色", user.get("role")],
+                ["状态", user.get("status")],
+            ],
+        )
+        token = identity.get("token") or {}
+        print_table(
+            title="当前 PAT",
+            columns=["字段", "值"],
+            rows=[
+                ["公开 ID", token.get("token_public_id")],
+                ["Scopes", ", ".join(token.get("scopes") or []) or "-"],
+                ["过期时间", token.get("expires_at") or "未设置"],
+            ],
+        )
+        print_table(
+            title="已授权工作空间",
+            columns=["ID", "空间名称", "成员角色"],
+            rows=[[w["id"], w["name"], w.get("role")] for w in workspaces],
+        )
+    except ApiClientError as err:
+        print_error(f"查询失败: {err.message}", code=err.code)
+        raise SystemExit(1)