DOCSPontx Hub
公开文档v1
本页统一 CLI

CLI / @pontx/hub-cli

一个 CLI,覆盖整个 API 目录。

安装 @pontx/hub-cli,搜索、查看和预演全部已收录 API,并调用允许在线执行的接口;编写脚本时可直接读取 JSON 输出。

01

安装与环境

统一 CLI 包名是 @pontx/hub-cli,命令名是 pontx-hub。

全局安装
pnpm add --global @pontx/hub-cli
pontx-hub --help
02

命令地图

发现命令以资源为中心;请求命令遵循 API 产品 → controller → 接口名称的层级。

list列出 API 产品
search <query>语义搜索 API、Endpoint 与 Schema
show <resource-id>读取一个稳定资源
<api> preview …构造并脱敏预演请求
<api> call …通过受控 Hub 代理调用
sdk <api>查看 SDK 包名与状态
skill list列出通用与产品 Skills
skill install安装通用 pontx-hub Skill
skill install <apiSlug>安装一个产品 Skill
03

搜索与检查

搜索结果会带上稳定的资源 ID,后续命令和脚本可以直接继续使用。

自然语言
pontx-hub search "返回 dueDate 的接口" --locale zh --json
pontx-hub show endpoint:dida365/get-task-by-id

--type 可重复传入 api、endpoint 或 schema;--limit 与 --offset 用于稳定分页。

04

构造请求

接口参数直接写成同名选项;请求体使用 --body,额外声明请求头使用 -H。

命令结构
pontx-hub <api-product> preview [controller] <endpoint-name> --parameter value

# Controller present
pontx-hub frankfurter preview 'Exchange Rates' getLatestRates --base USD

# No meaningful controller
pontx-hub frankfurter-v2 preview getRates --base USD
--projectId 123
推荐:直接使用 PontxSpec 参数名。
--body '<json>'
传入 JSON 请求体。
-H 'Header: value'
补充声明的原始请求头;不要在参数中暴露密钥。
05

脚本与自动化

程序消费时使用 --json,并保留退出码与 error.code。

机器可读输出
pontx-hub search "exchange rate" --type endpoint --json > results.json

# Keep credentials in the environment, never in CLI arguments.
export PROVIDER_ACCESS_TOKEN="<from-your-secret-manager>"
pontx-hub <api-product> preview <endpoint-name>