Skip to main content

Aukeys 运营 CLI 工具集

Project description

opscli

Aukeys 运营 CLI 工具集

当前模块:auth(认证授权)、query(数据查询)、skills(Skill 生命周期管理)、amazon(Amazon 数据采集);后续可扩展更多模块(deploy、notify 等)

说明:本文档中涉及 aukeys-opscli[amazon]opscli-core、独立模块包、动态插件化等内容,部分属于预留设计或未来演进方向。截至当前仓库版本,请以单包 aukeys-opscli + 仓库内静态注册模块为准,不要将这些内容视为已落地的发布承诺。

功能概述

auth 模块

  • Device Flow 授权:通过浏览器完成 CLI 登录认证
  • 多系统 Token 管理:统一获取和管理 ops/polaris 系统的 JWT
  • 三态 Token 状态valid / needs_refresh / expired,过期前 5 分钟自动刷新
  • Keychain 优先存储:macOS 钥匙串 → AES-256-GCM 文件双层兜底
  • 并发安全:线程锁 + 跨进程文件锁,防止多进程并发重复换取 JWT
  • Scope 权限展示status 命令自动解析 JWT 显示各系统已授权权限
  • Session 30 天有效期:每次浏览器授权确认自动续期
  • 可配置地址:支持通过配置文件覆盖系统地址,无需改代码

skills 模块

  • Skill 安装:支持安装内置 ops-dataset-query Skill 模板
  • Skill 扫描:自动扫描 --skills-dirOPSCLI_SKILLS_DIR.claude/skills.openclaw/skills
  • Skill 升级:从远端拉取 manifest、字段 CSV、数据集 CSV、查询元数据
  • 统一 JSON 输出:默认适合脚本消费,--pretty 可切换可读格式
  • 数据查询支持:通过 opscli skillsopscli query 组合完成元数据读取、构造 payload 与远端执行
  • Amazon Skill 模板:支持安装 ops-amazon,指导 AI 使用 opscli amazon 完成抓取和字段取样

query 模块

  • 元数据读取:支持按 dataset_aliastable_id 读取 query metadata
  • 查询构造:支持通过维度、指标、筛选、排序等参数生成标准 query payload
  • 即时执行:支持直接转发 payload 到远端查询服务
  • 图表查询:通过 chart_uuid 获取图表查询结构,支持多 query 并行执行与结果合并
  • JSON 优先输出:默认适合 Skill 和脚本消费

amazon 模块

  • 商品页抓取:抓取 Amazon 商品页价格、评分、评论数、配送位置等快照
  • 搜索结果抓取:抓取关键词搜索结果页,沉淀竞品结果集
  • 标准 payload 预留:输出未来提交给 ops API 的标准请求体
  • 本地历史存档:商品抓取结果可落本地 JSONL,便于趋势分析和后续补数

系统架构

graph TB
    subgraph 用户侧
        CLI["CLI 客户端<br/>opscli"]
        Browser["浏览器<br/>cli-auth 页面"]
    end

    subgraph 本地存储
        Store["CredentialStore<br/>Keychain 优先 / AES-256-GCM 兜底"]
        Config["config.ini<br/>系统地址配置"]
        Registry["systems.json<br/>自定义系统列表"]
    end

    subgraph ops 认证服务
        DeviceAPI["Device Flow API<br/>/api/v1/cli/device/*"]
        TokenAPI["Token API<br/>/api/v1/auth/cli-token"]
        SessionDB[("shared_login_sessions<br/>session 存储")]
    end

    subgraph 业务系统
        OpsAPI["ops 运营系统<br/>https://ops.api.qa.aukeyit.com"]
        PolarisAPI["polaris 刊登系统<br/>bi.aukeys.com"]
    end

    CLI -->|"1. 申请设备码"| DeviceAPI
    CLI -->|"自动打开"| Browser
    Browser -->|"2. 携带 polarisUserToken 确认授权"| DeviceAPI
    DeviceAPI -->|"读写 session"| SessionDB
    CLI -->|"3. 轮询获取 session_id"| DeviceAPI
    CLI -->|"4. session_id 换取 JWT"| TokenAPI
    CLI -->|"5. 携带 JWT + Cookie 调用业务 API"| OpsAPI
    CLI -->|"5. 携带 JWT + Cookie 调用业务 API"| PolarisAPI
    CLI --> Store
    CLI --> Config
    CLI --> Registry

安装

# 从 PyPI 安装(正式环境)
pip install aukeys-opscli

# 以下 extra 安装写法来自预留拆分设计,当前不作为正式发布承诺
# pip install "aukeys-opscli[amazon]"
# playwright install chromium

# 从 TestPyPI 安装(测试环境)
# ⚠️ 必须加 --extra-index-url,否则依赖解析会失败回退到旧版本
pip install \
    --index-url https://test.pypi.org/simple/ \
    --extra-index-url https://pypi.org/simple/ \
    aukeys-opscli

# 从源码开发模式安装
git clone <repo-url> opscli
cd opscli
pip install -e .

# 以下 extra 安装写法来自预留拆分设计,当前不作为正式发布承诺
# pip install -e ".[amazon]"
# playwright install chromium

发行包名为 aukeys-opscli,安装后仍使用 opscli 作为命令入口。

当前现状说明:仓库代码仍按单包方式维护与发布,文档中若出现 extras、拆包或插件化表述,请优先按“设计预留”理解。


快速开始

# 1. 登录授权
opscli auth login

# 2. 查看状态
opscli auth token status

# 3. 获取 ops 运营系统 JWT
opscli auth token get --system ops

# 4. 获取 polaris 刊登系统 JWT
opscli auth token get --system polaris

# 5. 安装 ops-dataset-query Skill
opscli skills install ops-dataset-query

# 6. 拉取真实数据
opscli skills upgrade ops-dataset-query

# 7. 抓取 Amazon 商品页
opscli amazon scrape --asin B09LCJPZ1P --include-raw --pretty

# 8. 输出预留给 ops API 的标准 payload
opscli amazon payload --asin B09LCJPZ1P --pretty

# 9. 抓取 Amazon 搜索结果
opscli amazon search --keyword "usb c cable" --limit 5 --pretty

# 10. 退出登录
opscli auth logout

核心流程图

Device Flow 授权登录

sequenceDiagram
    participant User as 用户
    participant CLI as CLI 客户端
    participant Backend as ops 认证服务
    participant Browser as 浏览器

    CLI->>Backend: POST /api/v1/cli/device/code
    Backend-->>CLI: device_code + user_code + verification_url

    CLI->>User: 显示验证码 + 自动打开浏览器
    User->>Browser: 在授权页面确认
    Browser->>Browser: 检测 polarisUserToken cookie
    Browser->>Backend: POST /api/v1/cli/device/confirm<br/>{user_code, polaris_user_token}

    alt 授权成功
        Backend-->>Browser: 200 OK → 显示成功
        Backend->>Backend: 创建 session(30天有效期)
    else 未登录 polaris
        Browser-->>User: 引导登录 polaris 系统
    end

    loop 轮询(每 3 秒)
        CLI->>Backend: POST /api/v1/cli/device/poll
        Backend-->>CLI: pending / authorized
    end

    CLI->>CLI: 保存 session_id + device_code 到加密存储
    CLI-->>User: ✓ 授权成功!账号:user@example.com

Token 获取与自动刷新

flowchart TD
    Start([get_token alias]) --> Load["加载本地凭证"]
    Load --> HasSession{"session_id 有效?"}

    HasSession -->|否| Error1["抛出 NotAuthenticatedError"]
    HasSession -->|是| CheckCache{"本地有缓存 JWT?"}

    CheckCache -->|否| FetchNew["用 session_id 向后端换取 JWT"]
    CheckCache -->|是| CheckValid{"JWT 有效<br/>距过期 > 5 分钟?"}

    CheckValid -->|是| Return["返回缓存的 JWT"]
    CheckValid -->|否| FetchNew

    FetchNew --> Backend["POST {system_url}{token_endpoint}<br/>{session_id}"]
    Backend --> CapTTL["限制 expires_in ≤ 86400s(24h)"]
    CapTTL --> Save["加密保存 JWT + expires_at"]
    Save --> Return

Token 生命周期

stateDiagram-v2
    [*] --> 未登录

    未登录 --> DeviceCode生成: opscli auth login
    DeviceCode生成 --> 等待授权: 显示验证码 + 打开浏览器
    等待授权 --> SessionActive: 用户确认授权<br/>轮询获取 session_id
    等待授权 --> 超时过期: 5 分钟未操作
    超时过期 --> 未登录

    SessionActive --> JWT有效: get_token<br/>session_id 换取 JWT
    SessionActive --> Session过期: 30 天未续期
    Session过期 --> 未登录

    JWT有效 --> JWT有效: get_token<br/>返回缓存(自动命中)
    JWT有效 --> 刷新中: 剩余 ≤ 5 分钟时<br/>自动触发刷新
    刷新中 --> JWT有效: 刷新成功<br/>新的 24h JWT

    note right of SessionActive
        每次浏览器授权确认
        自动续期 30 天
    end note

    note right of JWT有效
        JWT 最长 24h
        (MAX_JWT_TTL = 86400s)
    end note

CLI 命令参考

命令树总览

graph LR
    Root["opscli"]
    Root --- Auth["auth"]
    Root --- Query["query"]
    Root --- Skills["skills"]
    Root --- Amazon["amazon"]

    Auth --- login
    Auth --- logout
    Auth --- doctor
    Auth --- Token["token"]
    Auth --- System["system"]

    Token --- token_status["status"]
    Token --- token_get["get -s &lt;alias&gt;"]
    Token --- token_check["check -s &lt;alias&gt;"]
    Token --- token_refresh["refresh -s &lt;alias&gt; / --all"]

    System --- sys_list["list"]
    System --- sys_sync["sync"]
    System --- sys_add["add --alias --url"]
    System --- sys_remove["remove --alias"]

    Query --- query_metadata["metadata"]
    Query --- query_build["build"]
    Query --- query_run["run"]
    Query --- query_chart["chart --uuid"]

    Skills --- skills_list["list"]
    Skills --- skills_install["install <name>"]
    Skills --- skills_status["status"]
    Skills --- skills_upgrade["upgrade [name]"]

    Amazon --- amazon_scrape["scrape --asin"]
    Amazon --- amazon_payload["payload --asin"]
    Amazon --- amazon_search["search --keyword"]
    Amazon --- amazon_schema["schema"]
    Amazon --- amazon_history["history --asin"]

授权管理

opscli auth login - Device Flow 授权登录

opscli auth login

触发 Device Flow 授权流程:CLI 申请设备码 → 自动打开浏览器 → 用户确认授权 → CLI 获取 session。

输出示例

请在浏览器打开: http://ops.cm/cli-auth
输入验证码:   AB12-CD34
等待授权中...(300 秒内完成)

✓ 授权成功!账号:user@example.com

opscli auth logout - 退出登录

opscli auth logout

清除本地所有凭证(session_id + 全部系统 JWT)。

opscli auth token status - 查看登录状态

opscli auth token status

输出示例

已登录  user@example.com
Session 过期:2026-05-17T10:00:00

┏━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃ 别名    ┃ System Key   ┃ Token 状态 ┃ 剩余时间(s) ┃
┡━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│ ops     │ ops          │ 有效       │ 82800       │
│ polaris │ polaris      │ 有效       │ 82800       │
└─────────┴──────────────┴────────────┴─────────────┘
  权限(3 项):read write admin
  权限(2 项):read write

Token 管理

opscli auth token get - 获取 JWT(纯文本输出,适合脚本)

# 获取 ops 系统 JWT
opscli auth token get --system ops
opscli auth token get -s ops

# 获取 polaris 系统 JWT
opscli auth token get --system polaris
opscli auth token get -s polaris
参数 简写 必需 说明
--system -s 系统别名(ops / polaris)

脚本集成示例

# Shell 脚本中获取 token 并调用 API
TOKEN=$(opscli auth token get -s ops)
curl -s -H "Authorization: Bearer $TOKEN" \
    "https://https://ops.api.qa.aukeyit.com/api/v1/some-endpoint"

# Python 脚本中调用
python3 -c "
import httpx
from opscli import AuthClient
token = AuthClient().get_token('ops')
resp = httpx.get('https://https://ops.api.qa.aukeyit.com/api/v1/resource',
                  headers={'Authorization': f'Bearer {token}'})
print(resp.json())
"

opscli auth token check - 检测 Token 有效性

opscli auth token check --system ops
opscli auth token check -s polaris

opscli auth token refresh - 刷新 Token

# 刷新单个系统
opscli auth token refresh --system ops

# 刷新全部系统
opscli auth token refresh --all

系统管理

opscli auth system list - 列出所有已注册系统

opscli auth system list

opscli auth system sync - 从 ops 同步系统列表

opscli auth system sync

opscli auth system add - 手动添加系统

opscli auth system add --alias 数据分析 --url http://analytics.cm
opscli auth system add --alias 财务系统 --url http://finance.cm --key finance
参数 必需 说明
--alias 系统别名(用于 CLI 调用)
--url 系统 base URL
--key 存储键(默认从 alias 自动生成)

opscli auth system remove - 移除手动添加的系统

opscli auth system remove --alias 数据分析

内置系统(ops/polaris)不可移除,仅能移除 local 来源的系统。


诊断工具

opscli auth doctor - 环境检查

opscli auth doctor

输出示例

opscli auth 环境检查

✓ 已登录
✓ ops 可访问
✓ polaris 可访问

opscli --version - 显示版本

opscli --version
opscli -V

输出示例

opscli v0.0.4

Python SDK

作为 Python SDK 在其他项目中调用:

# 两种导入方式均可
from opscli import AuthClient
from opscli.auth import AuthClient

client = AuthClient()

方法列表

方法 返回值 说明
is_authenticated() bool 是否已登录
get_token(alias) str 获取 JWT(自动缓存+刷新)
get_session(alias) str 获取当前登录态对应的 session_id
get_device_code() str | None 获取当前登录态对应的 device_code
build_request_auth(alias) tuple[dict, dict] 构造业务接口请求所需的 headerscookies
build_session_headers(alias) dict 构造 ops session 型接口所需的 X-Session-Id 请求头
check_token(alias) dict 检测有效性,返回 {"valid": bool, "expires_in": int}
refresh_token(alias) str 强制刷新 JWT

使用示例

import httpx
from opscli import AuthClient

client = AuthClient()

# 检查登录状态
if not client.is_authenticated():
    print("未登录,请先执行: opscli auth login")
    exit(1)

# 获取统一认证参数并调用业务 API
headers, cookies = client.build_request_auth("ops")
resp = httpx.get(
    "https://https://ops.api.qa.aukeyit.com/api/v1/operation-reminder/list",
    headers=headers,
    cookies=cookies,
)
print(resp.json())

# 获取 polaris 系统统一认证参数
headers, cookies = client.build_request_auth("polaris")
resp = httpx.get(
    "https://bi.aukeys.com/api/some-endpoint",
    headers=headers,
    cookies=cookies,
)
print(resp.json())

其中 build_request_auth() 返回的认证参数形如:

headers = {"Authorization": "Bearer <jwt>"}
cookies = {
    "polarisUserToken": "<session_id>",
    "opscliDeviceCode": "<device_code>",  # 本地存在时自动附带
}

异常处理

from opscli import AuthClient
from opscli.auth.exceptions import (
    NotAuthenticatedError,
    TokenFetchError,
    SystemNotFoundError,
)

client = AuthClient()

try:
    token = client.get_token("ops")
except NotAuthenticatedError:
    print("未登录,请运行: opscli auth login")
except SystemNotFoundError:
    print("系统别名不存在,用 system list 查看可用系统")
except TokenFetchError as e:
    print(f"获取 JWT 失败: {e}")

在 pyproject.toml 中声明依赖

[project]
dependencies = [
    "opscli",
]

模块架构

graph TB
    subgraph "opscli 包结构"
        Init["__init__.py<br/>re-export AuthClient"]
        CLI["cli.py<br/>顶级 Typer app(挂载子模块)"]
        Config["config.py<br/>全局 CONFIG_DIR + 迁移函数"]
    end

    subgraph "opscli/auth/"
        AuthInit["__init__.py<br/>AuthClient, BUILTIN_SYSTEMS, OPS_URL"]
        AuthCLI["cli.py<br/>auth 子命令组"]
        AuthConfig["config.py<br/>auth 专属地址配置"]
        Exceptions["exceptions.py<br/>异常类定义"]
    end

    subgraph "opscli/auth/core/"
        TokenMgr["token_manager.py<br/>JWT 缓存/刷新/获取"]
        DeviceFlow["device_flow.py<br/>Device Flow 授权"]
        SysRegistry["system_registry.py<br/>系统注册表"]
    end

    subgraph "opscli/auth/storage/"
        CredStore["credential_store.py<br/>Keychain 优先 / AES 加密兜底"]
        Crypto["crypto.py<br/>AES-256-GCM"]
    end

    CLI --> AuthCLI
    AuthCLI --> AuthInit
    AuthInit --> TokenMgr
    AuthInit --> SysRegistry
    AuthInit --> CredStore
    AuthInit --> AuthConfig
    TokenMgr --> CredStore
    TokenMgr --> SysRegistry
    DeviceFlow --> CredStore
    SysRegistry --> Config
    CredStore --> Config
    CredStore --> Crypto

配置文件

存储目录

凭证优先存入系统 Keychain(macOS 钥匙串),Keychain 不可用时自动降级到本地加密文件。

~/.config/opscli/
├── config.ini         # 系统地址配置(可选,覆盖默认值)
├── credentials.bin    # 加密凭证兜底(Keychain 不可用时启用)
├── .key               # AES 加密密钥(权限 600,Keychain 兜底时使用)
├── .lock_<key>        # 跨进程并发文件锁(运行时临时文件)
└── systems.json       # 用户自定义系统列表

系统地址配置

代码中内置生产环境默认地址。如需覆盖(如本地开发),创建 ~/.config/opscli/config.ini

[systems]
# ops 认证服务地址
ops_url = http://localhost/api
# ops 运营系统地址
ops_system_url = http://ops.cm
ops_token_endpoint = /api/v1/auth/cli-token
# polaris 刊登系统地址
polaris_system_url = http://po2.cm
polaris_token_endpoint = /api/auth/cli-token

配置优先级config.ini 用户配置 > 代码默认值(生产环境)

Token 生命周期

类型 有效期 说明
Session ID 30 天 登录后签发,浏览器授权确认时自动续期
JWT Token 24 小时 用 session_id 换取,三态管理(过期前 5 分钟自动刷新)
Device Code 5 分钟 login 时生成,超时需重新执行 login

打包与发布

详见 打包发布指南

版本更新流程

# 1. 修改 pyproject.toml 中的 version 字段
#    version = "0.0.2"

# 2. 清理旧产物并构建
rm -rf dist/ build/
python -m build

# 3. 校验包
twine check dist/*

# 4. 发布到 TestPyPI 验证
twine upload --repository testpypi dist/*

# 5. 验证通过后发布到正式 PyPI
twine upload dist/*

TestPyPI 安装验证

重要:TestPyPI 上缺少部分依赖包(如 cryptography、httpx 等),安装时必须加 --extra-index-url 指向正式 PyPI,否则 pip 解析依赖失败后会回退到旧版本。

# 正确:指定额外索引源拉依赖
pip install \
    --index-url https://test.pypi.org/simple/ \
    --extra-index-url https://pypi.org/simple/ \
    aukeys-opscli==0.0.2

# 错误:只用 TestPyPI 做索引源,可能安装到旧版本
pip install -i https://test.pypi.org/simple/ aukeys-opscli

验证安装:

opscli --version
python -c "from opscli import AuthClient; print('SDK OK')"

常见问题

问题 原因 解决方式
File already exists PyPI 不允许覆盖同版本号 修改 pyproject.toml 中的 version 后重新构建
Invalid API Token ~/.pypirc 中 token 过期或错误 重新生成 token 并更新 ~/.pypirc
TestPyPI 安装到旧版本 缺少 --extra-index-url 加上 --extra-index-url https://pypi.org/simple/

错误处理

场景 错误信息 处理方式
未登录 未登录,请运行: opscli auth login 执行 login
session 过期 登录已过期,请重新运行: opscli auth login 重新 login
Token 过期 已过期或未获取 执行 token refresh 或自动刷新
系统别名不存在 系统 'xxx' 未注册 用 system list 查看,或 system add 添加
目标系统不可达 获取 xxx JWT 失败 用 doctor 检查连通性

skills 常见错误

场景 典型提示 处理方式
未登录 ops 未登录 ops,请先执行 opscli auth login 先执行 opscli auth login
远端环境未部署接口 远端环境未部署该 Skill 接口 检查 ~/.config/opscli/config.ini 中的 ops_url 是否指向已部署环境
远端接口鉴权失败 远端 Skill 接口鉴权失败 重新登录后重试
远端返回坏 JSON 远端接口返回了无法解析的 JSON 检查目标环境接口返回内容
本地未安装 Skill 未找到已安装 Skill: ops-dataset-query 先执行 opscli skills install ops-dataset-query

异常类

graph TD
    AuthError["AuthError<br/>认证异常基类"]
    NotAuth["NotAuthenticatedError<br/>未登录或 session 过期"]
    SessionExp["SessionExpiredError<br/>session_id 过期"]
    TokenFetch["TokenFetchError<br/>获取 JWT 失败"]
    SysNotFound["SystemNotFoundError<br/>系统别名不存在"]
    DeviceFlow["DeviceFlowError<br/>Device Flow 异常基类"]
    DFExpired["DeviceFlowExpiredError<br/>设备码超时"]
    DFDenied["DeviceFlowDeniedError<br/>用户拒绝授权"]

    AuthError --> NotAuth
    AuthError --> SessionExp
    AuthError --> TokenFetch
    AuthError --> SysNotFound
    AuthError --> DeviceFlow
    DeviceFlow --> DFExpired
    DeviceFlow --> DFDenied

依赖

  • Python >= 3.10
  • typer >= 0.12
  • httpx >= 0.27
  • cryptography >= 38, < 42
  • rich >= 13
  • keyring >= 25(Keychain 存储,macOS 钥匙串优先)

新增模块规范

opscli/cli.py 中追加一行注册:

from opscli.{module_name}.cli import app as {module_name}_app
app.add_typer({module_name}_app, name="{module_name}")

新模块配置统一存放在 ~/.config/opscli/ 下,通过 opscli.config.CONFIG_DIR 获取。

图表查询

opscli query chart - 通过 chart_uuid 获取查询结构并执行

# 仅查看图表查询结构
opscli query chart --uuid 32f660fd-f62a-45c4-a443-e21f2edb0779 --pretty

# 获取并执行所有查询(多 query 结果自动合并)
opscli query chart --uuid 32f660fd-f62a-45c4-a443-e21f2edb0779 --run --pretty

# 仅生成 SQL,不执行
opscli query chart --uuid 32f660fd-f62a-45c4-a443-e21f2edb0779 --run --dry-run --pretty
参数 必需 说明
--uuid 图表 UUID
--run 获取后立即执行所有查询
--dry-run 仅生成 SQL(需配合 --run
--pretty 格式化 JSON 输出

返回结构(--run 时)

{
  "chart_uuid": "xxx",
  "queries": [
    {"index": 0, "table_id": 1, "data_source": "doris", "result": {...}, "error": null}
  ],
  "merged": {
    "rows": [{"_query_index": 0, ...}],
    "meta": {"rowCount": 150, "queryCount": 3, "successCount": 3}
  }
}

每个 query 独立执行,失败不影响其他 query;合并结果中每行附加 _query_index 标识来源。

Skills 使用

opscli skills list

列出当前扫描到的已安装 Skill。

opscli skills list
opscli skills list --pretty
opscli skills list --skills-dir ~/.claude/skills

opscli skills install

安装内置 ops-dataset-query Skill 模板。

opscli skills install ops-dataset-query
opscli skills install ops-dataset-query --skills-dir ~/.claude/skills
opscli skills install ops-dataset-query --skills-dir ~/.claude/skills --force

opscli skills status

查看本地安装状态,并附带远端 manifest 摘要。

opscli skills status
opscli skills status --pretty

返回结果中会包含:

  • installed
  • remote_manifest
  • remote_summary
  • remote_error

opscli skills upgrade

从远端拉取最新的 ops-dataset-query 数据文件。远端数据只拉取一次,自动分发写入到所有检测到的安装目录。

opscli skills upgrade
opscli skills upgrade ops-dataset-query
opscli skills upgrade ops-dataset-query --force
opscli skills upgrade ops-dataset-query --pretty

优化说明upgrade 会检测所有安装目录(如 ~/.claude/skills~/.openclaw/skills 等),但远端数据仅拉取一次,再原子替换到所有目录,避免重复请求。

ops-dataset-query 典型工作流

推荐统一通过 opscli 正式命令入口完成 metadata 读取、payload 构造与执行,不直接调用 Skill 脚本:

opscli auth login
opscli skills install ops-dataset-query
opscli skills upgrade ops-dataset-query --pretty
opscli query metadata --dataset sales_order_d
opscli query build --dataset sales_order_d --dimension date_id --metric gmv --output payload.json
opscli query run --payload payload.json

skills 联调建议顺序

opscli auth login
opscli skills install ops-dataset-query
opscli skills status --pretty
opscli skills upgrade ops-dataset-query --pretty
opscli query metadata --dataset sales_order_d

skills 相关配置

可以通过配置文件覆盖后端地址:

[systems]
ops_url = https://https://ops.api.qa.aukeyit.com/api
ops_system_url = https://https://ops.api.qa.aukeyit.com
ops_token_endpoint = /api/v1/auth/cli-token

如果 skills status 返回 404,通常意味着 ops_url 指向的环境还没有部署这些 Skill 接口。

Amazon 使用

amazon 模块依赖 Playwright 浏览器环境。下面这组 pip install "opscli[amazon]" 文案来自早期预留设计,当前不应作为正式安装说明;如果后续要恢复为正式能力,请以实际发布说明为准。

# 预留设计示例,当前不作为正式发布承诺
# pip install "opscli[amazon]"
# playwright install chromium

opscli amazon scrape

抓取单个商品页,并可选输出原始字段镜像。

opscli amazon scrape --asin B09LCJPZ1P
opscli amazon scrape --asin B09LCJPZ1P --zip-code 10001 --include-raw --pretty
opscli amazon scrape --asin B09LCJPZ1P --no-save-history
参数 必需 说明
--asin 目标商品 ASIN
--zip-code 配送邮编,默认 10001
--save-history/--no-save-history 是否将快照落本地历史,默认保存
--include-raw 是否返回 raw 原始抓取字段
--pretty 是否格式化 JSON 输出

返回结构包含:

  • snapshot:标准化商品快照
  • history_path:本地历史 JSONL 路径
  • submit_result:当前保留字段,本期默认为 null

opscli amazon payload

抓取商品页,并输出预留给 ops API 的标准 payload。

opscli amazon payload --asin B09LCJPZ1P
opscli amazon payload --asin B09LCJPZ1P --zip-code 10001 --pretty
参数 必需 说明
--asin 目标商品 ASIN
--zip-code 配送邮编,默认 10001
--save-history/--no-save-history 是否将快照落本地历史,默认保存
--pretty 是否格式化 JSON 输出

返回结构包含:

  • payload.source:当前固定为 opscli.amazon
  • payload.snapshot:未来提交到 ops API 的商品快照对象
  • history_path:本地历史 JSONL 路径

opscli amazon search

抓取 Amazon 搜索结果页,适合做竞品池样本采集。

opscli amazon search --keyword "usb c cable"
opscli amazon search --keyword "usb c cable" --zip-code 10001 --limit 10 --pretty
参数 必需 说明
--keyword 搜索关键词
--zip-code 配送邮编,默认 10001
--limit 最大结果数,默认 10,范围 1-50
--pretty 是否格式化 JSON 输出

返回结构包含:

  • keyword
  • zip_code
  • count
  • results

说明:

  • 搜索结果页的 review_count_value 来自页面展示口径,可能是近似值
  • 商品页 scrapereview_count_value 更适合作为精确快照值

opscli amazon schema

输出当前 amazon 模块的字段契约,便于后端设计接口和表结构。

opscli amazon schema
opscli amazon schema --pretty
参数 必需 说明
--pretty 是否格式化 JSON 输出

opscli amazon history

读取某个商品的本地历史快照。

opscli amazon history --asin B09LCJPZ1P
opscli amazon history --asin B09LCJPZ1P --pretty
参数 必需 说明
--asin 目标商品 ASIN
--pretty 是否格式化 JSON 输出

默认历史路径位于 ~/.config/opscli/amazon/history/<ASIN>.jsonl

许可证

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aukeys_opscli-0.0.20.tar.gz (546.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aukeys_opscli-0.0.20-py3-none-any.whl (206.9 kB view details)

Uploaded Python 3

File details

Details for the file aukeys_opscli-0.0.20.tar.gz.

File metadata

  • Download URL: aukeys_opscli-0.0.20.tar.gz
  • Upload date:
  • Size: 546.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for aukeys_opscli-0.0.20.tar.gz
Algorithm Hash digest
SHA256 07ae7c2a315180394b172b6f07cae479212af16c9ecc7d84aaf330de37e4f7d7
MD5 6736d776ba00ae62b1deb55a040e287b
BLAKE2b-256 b2c84b98873a7b3250e1ad5d898ad69f8af61b32ca985449155a8bc580602b47

See more details on using hashes here.

File details

Details for the file aukeys_opscli-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: aukeys_opscli-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 206.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for aukeys_opscli-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 342bf24bd4202054c53562e139badd96902275537a7166ed7b197c9531b40a79
MD5 9c98f2f250d0a9e56d5ad8f6a89c8f7f
BLAKE2b-256 c626072319a7d251c185ba6ca1ac4c04f8212d01f68c689b2fa49cd5f589feec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page