✨ 开发者效率工具 · 正式发布

吉客云CLI

命令行管理吉客云资源 · 告别繁琐API调试
⬇️ 立即下载 📖 快速开始 📘API文档 🤖 AI Skill

即装即用,开箱即配

下载二进制单文件,无任何外部依赖。一条 configure 命令即可完成 AppKey/Secret 安全配置。

🛡️

自动签名 · 安全调用

内置吉客云开放平台签名算法,自动填充公共参数,让您专注业务逻辑,无需手算签名。

🧩

双模式灵活调用

api call 通用模式直接透传 method + bizcontent;业务命令(如 purch create)提供参数校验及友好提示。

📁

JSON 文件/字符串双输入

支持 --json 字符串或 --file 读文件,复杂参数更从容,完美适配 CI/CD 场景。

⚡ 快速开始

只需三步,开始使用吉客云CLI调用第一个接口。

1️⃣ 安装 & 配置

# 下载对应系统的二进制文件 (以 Windows 为例)
# 重命名为 jky-cli.exe 并放到系统 PATH 目录

# 首次运行配置凭证
./jky-cli configure
# 根据提示输入 AppKey 和 AppSecret

# 验证安装
./jky-cli --version

2️⃣ 调用开放平台API(通用模式)

# 查询商品信息
./jky-cli api call --method erp-goods.goods.getforqimen --json '{"goodsCode":"100","pageIndex":0,"pageSize":10}'

3️⃣ 使用业务命令(货品查询)

# 编辑参数后执行
./jky-cli goods search --goodsno 100

📖 命令参考

吉客云CLI遵循直观的层次化设计,所有命令均支持 --help 获取详细用法。

命令 说明 示例
configure 交互式配置 AppKey / AppSecret,凭证存入系统安全存储 jky-cli configure
api call 通用API调用,任意 method + bizcontent,自动签名 jky-cli api call --method erp.purch.create --file order.json
goods search 查询货品信息 jky-cli goods search --goodsno 货品编号
depart search 查询部门信息 jky-cli depart search --name 部门名称 --code 部门编码
version 显示当前版本及构建信息 jky-cli --version

💡 高级技巧

AI 智能体集成指南

1. 为 AI 智能体提供 API 文档
为了让 AI 智能体(如 Copilot、Claude、Cline 等)能理解并正确调用您的 CLI 工具,您需要为其准备一份 机器可读的 API 定义。我们推荐采用“两阶段文档”策略:
方法列表文件: methods-index.json :该文件是 AI 的“目录”,体积小,便于 AI 快速浏览所有可用命令。 https://open.jackyun.com/developer/jkyuncli/methods-index.json
方法详情文件: methods/${method}.json :当 AI 决定使用某个具体命令时,会根据索引文件中的 detailUrl 地址按需加载该文件,获取详细的参数、格式和必填项等信息。这种“懒加载”策略能有效避免 AI 一次性处理过多信息,提升响应速度和准确性。 示例:采购退货信息查询
2. 为 AI 提供清晰的系统提示
您可以将以下“AI 集成系统提示”模板分享给开发者,或直接提供给 AI 厂商进行系统集成:
您可以将以下 System Prompt 作为模板,提供给希望您的 CLI 适配到自家 AI Agent 的开发者:
## 吉客云 CLI (jky-cli) 使用指南

### 核心指令
当需要操作吉客云系统的订单、商品等资源时,必须使用 `jky-cli` 命令行工具。该工具的核心调用方式为:
`jky-cli api call --method <接口方法名> --json <业务参数JSON> 或者 --file <参数文件路径>`

### API 定义
本工具支持的所有接口定义遵循“两阶段文档”规范:
1.  **方法列表**:地址为 `https://open.jackyun.com/developer/jkyuncli/methods-index.json`。
    首次加载时,必须解析此文件以获取所有可用的 `method`(如 `erp.purchreturn.get`)、功能简介及其对应的 `detailUrl`。
2.  **方法详情**:根据索引文件中的 `detailUrl` 地址(如 `https://open.jackyun.com/developer/jkyuncli/methods/erp.purchreturn.get.json`),
    按需加载具体的接口定义,包括请求参数结构、响应格式和示例。

### 备选获取方式
某些 AI 应用可能因网络政策无法直接访问外部网址。为彻底解决此限制,CLI 工具内置了 docs 子命令,可直接通过命令行获取接口定义,规避网络访问风险:
1.  jky-cli docs list:获取所有可用方法的索引(作用同 methods-index.json)
2.  jky-cli docs get :获取指定方法的详细定义(作用同 {method}.json)

### 调用规则
1.  **参数封装**:调用时,只需将接口定义中 `request.schema` 里的 JSON 对象,直接作为 `--json` 参数的值。
    CLI 工具会自动处理 `bizcontent` 的包装、公共参数的填充以及计算签名,您无需关心签名和加密细节。
2.  **必填验证**:AI 模型必须校验接口要求的所有必填字段(参考 `request.schema` 中的 `required` 数组),缺少必填参数时,应提示用户补充。
3.  **输出解析**:成功调用后,接口会返回统一格式的 JSON(包含 `code`, `msg`, `result` 等字段)。
    AI 模型会为您解析此结果,提取 `result.data` 中的具体业务信息并呈现给用户。
### 注意事项
1.  如果复杂参数推荐使用 --file,避免命令行转义烦恼,尤其是参数本身存在【 \ " ' 】等特殊字符时。

📦 下载吉客云CLI

当前最新版本:v1.0.0 (2025年4月发布) — 支持 Windows / macOS / Linux

❓ 常见问题

Q1: 提示“未找到 appkey/appsecret”怎么办?

运行 jky-cli configure 并输入正确的 AppKey 和 AppSecret。配置信息会保存在系统凭证库(macOS钥匙串/Windows凭据管理器)或配置文件 ~/.jky-cli/config.yaml 中。

Q2: 调用接口返回签名错误?

请检查系统时间是否准确,以及 AppKey/Secret 是否与开放平台控制台保持一致。签名算法完全兼容吉客云官方规则,支持标准 MD5 加签。

Q3: 如何获取接口 method 和 bizcontent 结构?

前往 吉客云开放平台API文档 选择对应接口即可获取 method 和 JSON 入参示例。

Q4: 支持哪些操作系统?

支持 Windows 7+ (amd64), macOS 11+ (Intel/Apple Silicon), Linux 主流发行版 (amd64)。