支付宝小程序扩展能力 alipaydev命令行(CLI)

简介

alipay-dev 开发工具提供命令行方式进行开发，和持续集成，提高研发效率，提供小程序各种便捷工具。

支持 CLI 和 SDK 方式引入。

全局安装

npm install alipay-dev -g

工具初始化配置

1. 运行 alipaydev key create -w 生成密钥。

1. 运行 alipaydev key upload 自动打开浏览器配置页或直接前往 工具密钥设置 页面，配置工具公钥（第一步中生成的 公钥）以及设置 IP 白名单（可选），设置完成后系统会为您分配一个工具 ID（toolId）。

1. 工具密钥设置页面配置完成后，运行配置命令，设置第一步中生成的私钥和第二步系统分配的工具 ID（toolId）。

   alipaydev config set -i {工具id} 

输入参数说明

参数	必填	说明
-i, --tool-id	是	工具 ID
-k, --private-key	是	工具私钥

注意：

• 第一步和第二步是成对操作的，如果重新生成了本地密钥，需要同步执行第二步将公钥上传。
• 可通过 alipaydev config list 命令查看本地配置详情。

appId 和 spaceId 切换

以下所有命令，需要传入 --app-id 或小程序云开发的 --space-id，都可以提前选定或在每个命令中具体指定。

## 可以切换当前操作的小程序
alipaydev mini list
## 可以切换当前操作的云服务空间（如需使用小程序云开发，请提前开通）
alipaydev cloud space list
## 查看工具的配置信息
alipaydev config list

命令索引

可以通过 alipaydev -h 查看所有命令帮助，并且每个命令可通过增加 -h 参数查看明细说明（如 alipaydev mini -h）。

分类	说明	命令
配置	工具初始化配置	alipaydev config set
展示工具配置信息	alipaydev config list
小程序	小程序列表	alipaydev mini list
小程序预览	alipaydev mini preview
小程序上传	alipaydev mini upload
demo下载	alipaydev mini demo
云开发	云服务空间列表	alipaydev cloud space list
空间下的云函数列表	alipaydev cloud function list
启动本地云函数运行环境	alipaydev cloud function dev
调用本地函数	alipaydev cloud function local
上传云函数	alipaydev cloud function deploy
下载云函数	alipaydev cloud function download
密钥	密钥生成	alipaydev key create
密钥匹配检测	alipaydev key match
密钥转换	alipaydev key convert

小程序相关

小程序上传&设置体验版

alipaydev mini upload

示例代码

## 将/Users/workspace/Demos/todos 目录下的小程序源码上传
alipaydev mini upload -p /Users/workspace/Demos/todos


## 将/Users/workspace/Demos/todos 目录下的小程序源码上传并设置体验版（设置体验版功能仅开放给主账号）
alipaydev mini upload -p /Users/workspace/Demos/todos -e

参数说明

参数	必填	说明	默认值
-p, --project	是	项目目录	无
-i, --app-id	否	小程序appId	无
-v, --version	否	上传包版本	线上包版本自增 0.0.1
-c, --client-type	否	上传的终端。 支付宝：alipay，高德：amap	alipay
-e, --experience	否	上传成功后，自动设置为体验版本, 该功能只针对小程序主账号生效	false

FAQ：

报错：整包大小过大，实际大小超过 2048kb 限制

解决方案：精简图片等本地资源文件，或者使用 分包加载 功能。

报错：小程序源码过大

解决方案：清除node_modules 缓存，重新 install

小程序预览

alipaydev mini preview

示例代码

## 将 /Users/workspace/Demos/todos 目录下的小程序源码上传预览，对应appId为20190666750666
alipaydev mini preview -p /Users/workspace/Demos/todos -i 20190666750666


## 默认启动页为pages/index/index，参数q=v&id=33，小程序launch参数为name=demo&fromId=11
alipaydev mini preview -p /Users/workspace/Demos/todos -i 20190666750666 --page 'pages/index/index?q=v&id=33' --launch 'name=demo&fromId=11'

参数

参数	必填	说明	默认值
-p, --project	是	项目目录	无
-i, --app-id	是	小程序 appId	无
--page	否	落地页面，如："pages/index/index?q=v&id=33"	无
--launch	否	app.js的onLaunch中取得，如： "name=demo&fromId=11"	无
-f, --qrcode-format	否	返回二维码文件的格式，如：terminal、base64、image	image
-o, --qrcode-output	否	二维码文件保存路径	程序执行目录

Demo下载

alipaydev mini demo

示例代码

alipaydev mini demo


alipaydev mini demo --path /Users/workspace/Demos

输入参数说明

参数	必填	说明
-p, --path	否	下载到指定目录

云开发相关

查看云服务空间列表

alipaydev cloud space list

示例代码

## 查看云服务空间列表，在终端显示云服务空间的名称以及云服务空间的 ID
alipaydev cloud space list
## 云服务空间命令帮助
alipaydev cloud  space -h

查看云函数列表

alipaydev cloud function list

示例代码

## 查询服务空间下的云函数列表
alipaydev cloud function list -s a97326fa-014b-4f9b-bc90-e4be2d776627
## 云函数列表命令帮助
alipaydev cloud function list -h

输入参数说明

参数	必填	说明	默认值
-i, --app-id	是	小程序 appId	无
-s, --space	是	云服务空间 ID	无

上传云函数

alipaydev cloud function deploy

示例代码

## 上传云函数
alipaydev cloud function deploy -s a97326fa-014b-4f9b-bc90-e4be2d776627 -n getSum -p /xxx/yyy
## 上传云函数列表命令帮助
alipaydev cloud function deploy -h

输入参数说明

参数	必填	说明	默认值
-s, --space	是	云服务空间 ID	无
-n, --name	是	云函数名	无
-p, --project	是	云函数本地文件地址	无

下载云函数

## 下载云函数 main到 /server/functions目录下面


alipaydev cloud function download  -n main --path /server/functions

示例代码

## 上传云函数


alipaydev cloud function download --space a97326fa-014b-4f9b-bc90-e4be2d776627 -n getSum --path /a/b


## 上传云函数列表命令帮助


alipaydev cloud function download -h

参数说明

参数	必填	说明	默认值
-s, --space	是	云服务空间ID	无
-n, --name	是	云函数名	无
-p, --path	是	下载后保存路径	无

启动本地调试服务

alipaydev cloud function dev -p /server/functions --inspect

参数说明

参数	必填	说明	默认值
-i, --app-id	否	小程序 appId	无
-p, --project	是	云函数根目录	无
--port	否	服务启动端口	3636
--inspect	否	启动 chrome 调试器	false

调用本地云函数

alipaydev cloud function local -p /server/functions -n main --input '{"x":1,"y":2}'

参数说明

参数	必填	说明	默认值
-i, --app-id	否	小程序 appId	无
-s, --space-id	否	云服务空间 ID	无
-p, --project	是	云函数根目录	无
-n, --name	是	云函数名	无
--input	否	云函数参数，JSON 字符串	无

密钥相关

密钥生成

alipaydev key create

示例代码

## 在当前目录生成密钥文件，并在终端中打印。密钥类型RSA2，密钥格式PCKS8
alipaydev key create


## 在指定目录生成密钥文件，并在终端中打印
alipaydev key create -t rsa2 --pub-path=/Users/keys/public.txt   --pri-path /Users/keys/private.txt


## 密钥生成帮助
alipaydev key -h

参数说明

参数	必填	说明	默认值
-t，--type	否	密钥类型（rsa2/rsa）	rsa2
-s，--scheme	否	密钥格式（pkcs8/pkcs1）	pkcs8
--pub-path	否	公钥保存地址	当前工作目录
--pri-path	否	私钥保存地址	当前工作目录

工具密钥配置

无参数，打开浏览器后，上传本地生成的公钥

alipaydev key upload

密钥匹配检测

alipaydev key match

示例代码

## 校验public.txt 和private.txt 中存放的公私钥是否成对匹配
alipaydev key match --pub-path=/Users/keys/public.txt   --pri-path /Users/keys/private.txt


## 密钥匹配帮助
alipaydev key match -h

参数说明

参数	必填	说明
--pub-path	是	公钥地址
--pri-path	是	私钥地址

密钥转换

alipaydev key convert

示例代码

## 将 private.txt中的私钥转换成pcks1格式
alipaydev key convert --pri-path /Users/keys/private.txt -s pkcs1




## 密钥转换帮助
alipaydev key convert

输入参数说明

参数	必填	说明	默认值
-s，--scheme	否	秘钥格式（pkcs8/pkcs1）	pkcs8
--pri-path	是	私钥地址	无

官方钉钉服务群

可扫描以下二维码进群咨询命令工具相关事项。