Registry 命令

registry命令是将安利模板发到 Serverless Registry 并对相关内容进行管理的命令。

命令解析

通过执行s registry -h，可以进行相关帮助信息的查看：

Usage: s registry [commands] [options]

You can manage Serverless Packages on Serverless Registry.

📖  Document: https://serverless.help/t/s/registry

Options:
  -h, --help                      Display help for command

Commands:
  login [options]                 😃  Login Serverless Registry
  publish                         ✅  Public Serverless Package to Serverless Regsitry
  list [options]                  🐵  List the packages you have published
  detail [options]                🌱  View specific package details
  delete [options]                ❌  Delete specific package
  help [command]                  display help for command

在该命令中，包括了五个子命令

registry login 命令

通过该命令，可以登陆 Serverless Registry。

执行s registry login -h命令，可以看到帮助文档：

Usage: s registry login [options]

Login Serverless Registry.

Example:
  $ s registry login
  $ s registry login --token xxxxxxxxxxxxxxx
  $ s registry login --retoken
   
📖  Document: https://serverless.help/t/s/registry-login

Options:
  --token <token>                 Login by token
  --retoken                       Reset login token
  -h, --help                      Display help for command

参数解析

参数全称参数缩写是否必填参数含义
token-选填通过指定的token登陆
retoken-选填重置登陆token

操作案例

登陆有两种模式：

  • 模式1：已经拥有了登陆后的token信息，此时可以使用s registry login --token <token>直接进行token的配置；
  • 模式2：没有登陆后的token信息，或者还没有注册过 Serverless Registry，此时可以通过s registry login直接打开浏览器，按照操作提示进行登录授权。

如果因为某些情况，导致 Serverless Registry 的 Token 信息泄漏，此时可以通过s registry login --retoken重置token。

registry publish 命令

通过该命令，可以将符合 Serverless Package 规范的项目进行发布。

执行s registry publish -h命令，可以看到帮助文档：

Usage: s registry publish [options]

Publish Serverless Registry.

Example:
  $ s registry publish
   
📖  Document: https://serverless.help/t/s/registry-publish

Options:
  -h, --help                      Display help for command

操作案例

配置正确的情况下，在该组件根目录下执行s registry publish之后可以看到结果:

$ s registry publish
Package complete.

registry list 命令

通过该命令，可以查看当前登陆到 Serverless Registry 账号所发布的组件。

执行s registry list -h命令，可以看到帮助文档：

Usage: s registry list [options]

View the components published by the current login to the Serverless Registry account.

Example:
  $ s registry list
   
📖  Document: https://serverless.help/t/s/registry-list

Options:
  --category <category>           category ID
  --tag <tag>                     Tag ID
  --search <search>               Search keyword
  --page <number>                 Page number (default: "1")
  -h, --help                      Display help for command

参数解析

参数全称参数缩写是否必填参数含义
category-选填通过category ID进行筛选
tag-选填通过tag ID进行筛选
search-选填通过搜索关键词进行筛选
page-选填指定查看的页码

操作案例

可以通过s registry list指令查看当前登陆到 Serverless Registry 账号所发布的组件。例如：

$ s registry list
- 
  id:           9
  type:         Component
  name:         aliyun_oss_bucket
  description:  通过阿里云 ROS 部署阿里云资源
  show:         公开
  organization: 
    id:   1
    name: 阿里云函数计算（FC）
  user: 
    id:       3
    username: ******
  download:     0
  provider: 
    - 阿里云
  platform:     3
  category: 
    id:   3
    name: 基础云服务
  tags: 
    - ROS
    - IAC
-
...

list指令会输出所有组件。在组件过多的情况下，可以通过category, tag和page参数进行筛选，还可以通过search参数搜索特定的组件。

registry detail 命令

通过该命令，可以查看指定 Package 的信息。

执行s registry detail -h命令，可以看到帮助文档：

Usage: s registry detail [options]

View application details.

Example:
  $ s registry detail --package-name fc3
   
📖  Document: https://serverless.help/t/s/registry-detail

Options:
  --package-name <name>           Serverless Package name
  --page <number>                 Page number (default: "1")
  -h, --help                      Display help for command

参数解析

参数全称参数缩写是否必填参数含义
package-name-必填指定要查看的 Package
page-选填指定查看的页码

操作案例

如果想要查看某个 Package 的详细信息，可以通过s registry detail --package-name <package-name>进行查看。例如：

$ s registry detail --package-name fc3
- 
  platform:    3
  tag_name:    0.0.8
  created_at:  ******
  zipball_url: ******
- 
  platform:    3
  tag_name:    dev.0.56
  created_at:  ******
  zipball_url: ******
- 
...

若输出结果过多，可以使用page参数进行分页查看。例如：

$ s registry detail --package-name fc3 --page 2
- 
  platform:    3
  tag_name:    dev.0.41
  created_at:  ******
  zipball_url: ******
- 
...

registry delete 命令

通过该命令，可以删除已发布的 Serverless Package。

执行s registry delete -h命令，可以看到帮助文档：

Usage: s registry delete [options]

Delete application version.

Example:
  $ s registry delete --name fc --version-id 1.0.1
   
📖  Document: https://serverless.help/t/s/registry-delete

Options:
  --name <name>                   Serverless Package name
  --version-id <version-id>       Serverless Package version
  -h, --help                      Display help for command

参数解析

参数全称参数缩写是否必填参数含义
name-必填指定要删除的 Package 名字
version-id-必填指定要删除的 Package 版本

操作案例

通过s registry delete --name <name> --version-id <version-id>可以删除特定包的特定版本。若包不存在或版本错误，会提示：

$ s registry delete --name fc --version-id 1.0.1
 
Error Message:
未找到指定资源
在 GitHub 上编辑本页面 更新时间： Fri, Nov 24, 2023
常用Tips 大代码包部署的实践案例