# 整体规范遵循原则： 1. 更清晰，更简约，尽可能给用户展示有效信息； 2. 可溯源，可排障，让开发者可以清晰了解错误内容；对比2.0新增功能： 1. 国际化能力，需要提供中文和英文两种语言的支持； 2. 进一步优化输出信息和效果； 3. 新增`centet`, `registry`, `preview`等几命令； 4. Yaml 规范升级；整体内容如下： 1. 项目整体通过`-h/--help`进行帮助文档的输出； 2. 项目打印等级分为：`Debug`, `Info`, `Waring`,`Error`, `Success`五个等级。其中： * `Debug`：灰色，尽可能打印全部信息（敏感信息屏蔽），并将所有信息进行存储，便于溯源； * `Info`：白色，打印简洁信息； * `Waring`：黄色，用户提醒，警告； * `Error`：红色，用于错误； * `Success`：绿色，用于正确结果提醒； 3. 执行阶段统一格式： ``` ⌛ Steps for [deploy] of [project name] ==================== ✔ [resource name] completed (10s) ``` ![image-20230413114352430](https://www.images.wiki/ldsayquSd3SlvbtdxucZ.png) 1. 结果输出统一格式： * 成功 ```bash ⌛ Steps for [deploy] of [project name] ==================== ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) 🚀 Result for [deploy] of [project name] ==================== fc-deploy-test: region: cn-hangzhou service: name: fc-deploy-service memorySize: 128 ``` ![image-20230413114214436](https://www.images.wiki/uqjisl5ZxlFj1y7Alhlu.png) * 失败 * 有优化信息提醒 ```bash ⌛ Steps for [deploy] of [project name] ==================== ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✖ [resource name] failed to [deploy] (5s) ❌ Result for [deploy] of [project name] ==================== Error Message: t[r] is not a function 👀 Get detail log: s cli runlog xxxxxxxxxx 🍼 Tips ==================== you can you can you can Env: darwin, node v15.14.0 Logs: ~/demo/demo/demo/s.log Get Help: DingTalk: xxxxxxxxxxx Feedback: https://feedback.serverless-devs.com ``` ![image-20230413113859154](https://www.images.wiki/1kz9AjeaquvAAS2ZCq8u.png) * 无优化信息提醒 ```bash ⌛ Steps for [deploy] of [project name] ==================== ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✔ [resource name] completed (10s) ✖ [resource name] failed to [deploy] (5s) ❌ Result for [deploy] of [project name] ==================== Error Message: t[r] is not a function 👀 Get detail log: s cli runlog xxxxxxxxxx Env: darwin, node v15.14.0 Logs: ~/demo/demo/demo/s.log Get Help: DingTalk: xxxxxxxxxxx Feedback: https://feedback.serverless-devs.com ``` ![image-20230413113826499](https://www.images.wiki/GDBuEsb78ezZSfefuxuC.png) 2. 关于日志打印规范格式： * 日志无论在任何时候，任何情况，**不允许输出用户明文密钥信息** * 首字母必须大写 * 日志的输出（在不使用--debug的前提下），只允许输出以下内容 * 正在获取信息 ```bash Getting <资源类型>: <资源详情> E.g.: Getting fc-custom-domain: todolist.todolist-demo-servicea.1583208943291465.cn-hangzhou.fc.devsapp.net ``` ![image-20230413105829507](https://www.images.wiki/A18AGhf4AAABkvCAfjse.png) * 正在设置信息 ```bash Setting <资源类型>: <资源详情> E.g.: Setting fc-custom-domain: todolist.todolist-demo-servicea.1583208943291465.cn-hangzhou.fc.devsapp.net ``` ![image-20230413105853966](https://www.images.wiki/qdaieEtgfcscBrSD4wZd.png) * 正在创建资源 ```bash Creating <资源类型>: <资源详情> E.g.: Creating fc-serivce: cn-hangzhou/my-test-service ``` ![image-20230413110008700](https://www.images.wiki/DcFdsf9ewAZ481i2wreS.png) * 正在更新资源 ```bash Updating <资源类型>: <资源详情> E.g.: Updating fc-function: cn-hangzhou/my-test-service/my-test-function ``` ![image-20230413110059368](https://www.images.wiki/467iebb7Z8G5bxax7deC.png) * 正在删除资源 ```bash Removing <资源类型>: <资源详情> E.g.: Removing fc-function: cn-hangzhou/my-test-service/my-test-function ``` ![image-20230413110137915](https://www.images.wiki/iFtF3k5Sdtg14F5A7FfD.png) * 正在检查资源 ```bash Checking <资源类型> <资源详情> -> <目标> E.g.: Checking fc-function: cn-hangzhou/my-test-service/my-test-function -> exists ``` ![image-20230413110449142](https://www.images.wiki/w4kz3zjB9lacgawqqefs.png) * 完成资源获取 ```bash Got <资源类型>: <资源详情> E.g.: Got fc-custom-domain: todolist.todolist-demo-servicea.1583208943291465.cn-hangzhou.fc.devsapp.net ``` ![image-20230413110830504](https://www.images.wiki/eik2y4f249x3BlAy3x9s.png) * 完成设置信息 ```bash Set <资源类型>: <资源详情> E.g.: Set fc-custom-domain: todolist.todolist-demo-servicea.1583208943291465.cn-hangzhou.fc.devsapp.net ``` ![image-20230413110850691](https://www.images.wiki/qaybfE2CyCEeC53x1aCS.png) * 完成创建资源 ```bash Created <资源类型>: <资源详情> E.g.: Created fc-serivce: cn-hangzhou/my-test-service ``` ![image-20230413110955162](https://www.images.wiki/Gc1FeZ7EArvsqerqAqsD.png) * 完成更新资源 ```bash Updated <资源类型>: <资源详情> E.g.: Updated fc-function: cn-hangzhou/my-test-service/my-test-function ``` ![image-20230413111046953](https://www.images.wiki/bZx7kzirCbhByS2AAB8B.png) * 完成删除资源 ```bash Removed <资源类型>: <资源详情> E.g.: Removed fc-function: cn-hangzhou/my-test-service/my-test-function ``` ![image-20230413111108145](https://www.images.wiki/9eZszgcl94Czik89yFlG.png) * 完成检查资源 ```bash Checked <资源类型> <资源详情> <目标> E.g.: Checked fc-serivce cn-hangzhou/my-test-service/my-service exists ``` ![image-20230413111155754](https://www.images.wiki/duq6ubc6bvrt9CkSdgbz.png) * 使用信息 ```bash Using <资源类型>: <资源详情> <目标> E.g.: Using region: cn-hangzhou Using access: default ``` ![image-20230413110650484](https://www.images.wiki/GS166z1BcxxlrgSqi53A.png) * 重试操作 ```bash Retrying <资源类型>: <行为> <资源信息>, retry <次数>/<最大次数> times E.g.: Retrying fc-function: create cn-hangzhou/my-test-service/myfunction Retrying fc-function: create cn-hangzhou/my-test-service/myfunction, retry 1/3 times ``` ![image-20230413110540198](https://www.images.wiki/45sjrqSD4d5Ej6l25691.png) 3. Exit Code 定义 | code | 含义 | |----|----| | 0 | 正常退出 | | 100 | Serverless Devs 工具本身错误退出 | | 101 | Serverless Devs 工具组件执行时，组件错误引起的退出 | 4. 优先级定义在使用 Serverless Devs 开发者工具时，会遇到一些带有默认值的参数/变量，这一部分将会针对这些参数/变量，进行优先级划分，在每个类别下面的列表中，上面的情况优先级高于下面的情况，例如`Yaml 文件优先级规范`为案例，描述为： * 通过`-t/--template`参数指定的 Yaml 文件 * 默认的 Yaml 文件（`s.yaml`/`s.yml`，且`s.yaml`的优先级大于`s.yml`）则 Serverless Devs 开发者工具在进行资源描述文件使用时，会优先选择`通过 -t/--template 参数指定的 Yaml 文件`，其次才会采用`默认的 Yaml 文件（ s.yaml/s.yml，且 s.yaml 的优先级大于 s.yml ）` * Yaml 文件优先级规范 * 通过`-t/--template`参数指定的 Yaml 文件 * 默认的 Yaml 文件（`s.yaml`/`s.yml`，且`s.yaml`的优先级大于`s.yml`） * 应用内服务部署顺序 * 用户指定的部署顺序 > 需要注意的是，如果系统有 n 个 resource，而用户指定了其中 m 个resource（m 例如，某资源描述 Yaml 可以缩写成： > > ```yaml > resources: > nextjs-portal: # 服务名称 > component: vue-component # 组件名称 > props: # 组件的属性值 > src: ./frontend_src > url: url > > assets: > component: static > props: > www: './public' > > gateway: > component: serverless-gateway # 路由组件：HTTP URL和服务之间的映射规则 > props: > routes: > - url: ${assets.output.url} > ``` > > \ > 此时，可先进性依赖关系分析，服务`nextjs-portal`、`assets`没有额外依赖，服务`gateway`通过魔法变量`${assets.output.url}`依赖了`assets`服务；此时部署顺序则为：`nextjs-portal`、`assets`按照上下顺序部署, 之后 `gateway` 拿到 `assets` 服务的返回结果再进行部署 > 即：`nextjs-portal`->`assets`->`gateway` 5. 密钥使用顺序与规范 * 通过`-a/--access`参数指定的密钥信息 * 使用已经配置为`default`密钥信息 * 使用通过环境变量配置的`default_serverless_devs_access`密钥信息 * 不使用密钥信息 / 进入密钥信息配置引导 6. Serverless Devs 可以比较容易的通过环境变量进行密钥信息的设定。通过环境变量配置密钥的方法有两种： 1. 通过命令引入环境变量中的密钥：例如在环境变量中有`ALIBABA_CLOUD_ACCOUNT_ID`、`ALIBABA_CLOUD_ACCESS_KEY_ID`、`ALIBABA_CLOUD_ACCESS_KEY_SECRET`等相关内容，此时可以通过`s config add`命令进行添加： ```bash s config add -a default-aliyun -kl AccountID,AccessKeyID,AccessKeySecret -il ${ALIBABA_CLOUD_ACCOUNT_ID},${ALIBABA_CLOUD_ACCESS_KEY_ID},${ALIBABA_CLOUD_ACCESS_KEY_SECRET} ``` 2. 通过指定环境变量的名字进行配置：例如当前有阿里云密钥对： * AccountID: temp_accountid * AccessKeyID: temp_accesskeyid * \ AccessKeySecret: temp_accesskeysecret此时可以在环境变量中可以命名 key 为`*********_serverless_devs_access`，例如`default_serverless_devs_access`，value 为 JSON 字符串，例如： * Key：`default_serverless_devs_access` * \ Value：`{\"AccountID\":\"temp_accountid\",\"AccessKeyID\":\"temp_accesskeyid\",\"AccessKeySecret\":\"temp_accesskeysecret\"}`此时，可以在配置密钥的时候指定密钥`default_serverless_devs_access`，例如`${env(default_serverless_devs_access)}` 在`s.yaml`配置如下: ```yaml edition: 3.0.0 # 命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范 access: default_serverless_devs_access # 秘钥别名 resource fc-deploy-test: component: fc-deploy # 组件名称 props: # 组件的属性值 region: cn-shenzhen service: name: fc-deploy-service ``` # 整体逻辑通过执行`s`可以快速进行创建引导： ```bash 😃 Welcome to the Serverless Devs, You can obtain more help through the -h/--help command or view more information through the documentation: Quick Start: https://docs.serverless-devs.com/quick-start Documentation: https://docs.serverless-devs.com Feedback: https://feedback.serverless-devs.com ? No Serverless Devs project is currently detected. Do you want to create a new project? Yes/No 🚀 More applications: https://registry.serverless-devs.com ? Hello Serverless for Cloud Vendors (Use arrow keys or type to search) ❯ Alibaba Cloud Serverless AWS Cloud Serverless Tencent Cloud Serverless Huawei Cloud Serverless Baidu Cloud Serverless Dev Template for Serverless Devs ``` 通过执行`s -h` / `s --help`可以查看帮助信息: ```bash $ s -h 😃 Welcome to the Serverless Devs. Options --debug Debug model, print more logs --skip-actions Skip the actions(global actions and project actions) -t, --template Specify the template file, default: s.yaml, s.yml -a, --access Specify the access alias name -o, --output Specify the output format: json, yaml, raw -v, --version Output the version number -h, --help Display help for command Commands config 👤 Configure venders account init 💞 Initializing a serverless project verify 🔎 Verify the correctness of Yaml format edit 🙌 Visual editing of Yaml files set 🔧 Settings for the tool clean 💥 Clean up the environment and cahce component 🔌 View installed component information preview 👀 Preview Yaml render results center 🙆 Serverless project management platform registry 🚢 Serverless registry platform cli 🐚 Operation without yaml 🧭 Custom Commands Custom Commands： Can be used in projects with Serverless Devs Yaml. Usage： - s ：Operate on the project, E.x: s deploy - s ：Operate on the resource, E.x: s website deploy More information: https://serverless.help/custom Build & Deploy deploy Deploy local resources online build Build the dependencies. remove The ability to delete resources 🙌 Quick Start: https://docs.serverless-devs.com/quick-start 🌟 Github Repo: https://github.com/Serverless-Devs/Serverless-Devs 💡 Documentation: https://docs.serverless-devs.com 🚀 Example Projects: https://registry.serverless-devs.com 📝 Feedback: https://feedback.serverless-devs.com ``` ## 执行引擎与逻辑 ![image-20230506180202292](https://www.images.wiki/AGsG6dky9vaC19lZFGjv.png) 1. 工具增加本地公共存储能力，这部分存储将会存储用户的状态和日志信息，项目划分通过（以下两种方法2选1）： 1. 直接通过 Yaml 中的 name, stage 字段进行区分【倾向于这种】 2. 引擎启动时，产生projectId，缓存到当前项目的.s 目录下，作为项目的主键 2. 串行或并行逻辑，优先采纳用户指定的 Flow； 3. 云上部署，数据上报将会采用插件形式进行提供，Center功能默认为白屏能力； 4. ~~当前阶段依旧在宿主机进行部署操作，但是将操作历史信息，同步到云上；（为什么不直接采用云上部署的方案？a. 额外的云上开销，b. 权限问题难以处理，c. 额外的网络传输消耗，影响性能，更可能出现额外的网络问题；）~~ 5. ~~数据上报环节在整理汇总操作部分，这部分将会整理输出结果，错误信息以及数据上报等；是否进行数据上报取决于配置的Center信息；~~ ## **数据上报&云上执行** ``` actions: pre-deploy: - plugin: alibaba-cloud-deploy complete-deploy: - plugin: alibaba-serverless-dev-center ``` 使用`plugin: alibaba-serverless-dev-center`表示数据上报到阿里云开发中心，使用`plugin: alibaba-cloud-deploy`表示走云上部署能力。当然，在使用之前可以考虑用其他的命令进行配置，例如：`s cli alibaba-cloud-deploy login`等。 * alibaba-cloud-deploy：该方法会拦截s启动器的后续流程，直接完成云上的部署能力； * alibaba-serverless-dev-center：操作完成之后，进行数据上报等； # 命令相关 ## config 命令 `config`命令是密钥信息相关的命令，包括密钥的配置、密钥的查看以及密钥的修改、删除等。当执行`s config`或增加`-h/--help`命令之后，可以进行相关帮助信息的查看： ```bash Usage: s config [commands] [options] Configure venders account, including Alibaba Cloud, Baidu Cloud, Huawei Cloud, Tencent Cloud, etc. 📖 Document: https://serverless.help/s/config Options -h, --help Display help for command Commands add + Add an account get √ Get accounts delete × Delete an account rename > Rename an account default * Set default account ``` 通过`s config add`命令，可以进行密钥的配置，使用者可以通过不同厂商的默认密钥模板进行密钥配置，也可以通过`Custom`选项进行自定义密钥配置。执行`s config add -h/--help`命令： ```bash Usage: s config add [options] You can add an account Example: $ s config add $ s config add --AccessKey ****** --SecretKey ****** $ s config add --AccessKeyID ****** --AccessKeySecret ****** --AccountID ****** --SecurityToken ****** $ s config add --keyList key1,key2,key3 --valueList value1,value2,value3 Configuration parameters template for vendors: alibaba: AccessKeyID, AccessKeySecret aws: AccessKeyID, SecretAccessKey baidu: AccessKeyID, SecretAccessKey huawei: AccessKey, SecretKey google: PrivateKeyData tencent: AccountID, SecretID, SecretKey 📖 Document: https://serverless.help/s/config#add 📖 Get vendor account: https://serverless.help/s/config#add-vendor 📖 More config methods: (E.x. env variables): https://serverless.help/s/config#add-more Options --AccountID AccountID of key information --AccessKeyID AccessKeyID of key information --AccessKeySecret AccessKeySecret of key information --SecurityToken SecurityToken of key information --SecretAccessKey SecretAccessKey of key information --AccessKey AccessKey of key information --SecretKey SecretKey of key information --SecretID SecretID of key information --PrivateKeyData PrivateKeyData of key information -kl, --key-list Keys of key information, like: -kl key1,key2,key3 -il, --info-list Values of key information, like: -il info1,info2,info3 -a, --access Specify the access alias name. -f, --force Mandatory overwrite key information -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|:---| | AccountID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | AccessKeyID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | AccessKeySecret | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | SecurityToken | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | SecretAccessKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | AccessKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | SecretKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | SecretID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | PrivateKeyData | - | 选填 | 部分云厂商配置密钥所需要的默认字段 | | key-list | kl | 选填 | 在默认字段无法满足配置诉求时，可以通过`keyList`与`infoList`进行批量自定义配置 | | info-list | il | 选填 | 在默认字段无法满足配置诉求时，可以通过\`\`keyList`与`infoList\`进行批量自定义配置 | | access | a | 选填 | 密钥的别名 | | force | f | 选填 | 强制修改/覆盖已经配置的密钥信息 | 执行`s config add`： ```bash You can add an account through the following options. 📖 Document: https://serverless.help/s/config#add 📖 Get vendor account: https://serverless.help/s/config#add-vendor 📖 More config methods: (E.x. env variables): https://serverless.help/s/config#add-more ? Please select a vendor: (Use arrow keys) ❯ Alibaba Cloud (alibaba) AWS (aws) Azure (azure) Baidu Cloud (baidu) Google Cloud (google) Huawei Cloud (huawei) Tencent Cloud (tencent) Custom (others) (Move up and down to reveal more choices) ``` 选择对应的厂商进行添加： ```bash ? Please select a provider: Huawei Cloud (huawei) 📖 Get Huawei Cloud account: https://serverless.help/s/config#add-vendor ? AccessKeyID: aaaa ? SecretAccessKey: aaa 📖 More introduction to access aliases: https://serverless.help/s/config#add-vendor ? Please create alias for access (default is: default-1) ? Do you want to set this access as the default: aaa ``` 添加成功： ```bash ? Please select a provider: Huawei Cloud (huawei) 📖 Get Huawei Cloud account: https://serverless.help/s/config#add-vendor ? AccessKeyID: aaaa ? SecretAccessKey: aaa 📖 More introduction to access aliases: https://serverless.help/s/config#add-vendor ? Please create alias for access: default-1 🚀 Result for [config add] ==================== Alias: default-1 Default: true AccessKeyID: aaaa SecretAccessKey: aaa 🍼 Tips ==================== You can start the Huawei Cloud Serverless journey by using the [s init start-huawei] command. Without specifying an access, the system will default to using the current access. ``` 也可以通过命令式直接进行密钥的添加： ```shell scripbasht s config add --AccessKeyID ****** --AccessKeySecret ****** ``` 或者添加自定义内容： ```bash s config add -kl key1,key2,key3 -il info1,info2,info3 ``` > 常见云厂商密钥配置内容 > > ```yaml > alibaba: AccountID, AccessKeyID, AccessKeySecret, > aws: AccessKeyID, SecretAccessKey, > baidu: AccessKeyID, SecretAccessKey, > huawei: AccessKeyID, SecretAccessKey, > azure: KeyVaultName, TenantID, ClientID, ClientSecret, > tencent: AccountID, SecretID, SecretKey, > google: PrivateKeyData > ``` 通过`config get`命令，您可以获得配置过的账号信息。执行`s config get -h/--help`命令可以查看到配置帮助： ```bash Usage: s config get [options] You can get accounts. Example: $ s config get $ s config get -a demo 📖 Document: https://serverless.help/s/config#get Options -a, --access Specify the access alias name -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | access | a | 选填 | 密钥的别名 | 操作案例：如果想获得全部的一配置的密钥信息，可以执行`s config get`命令: ```bash 🚀 Result for [config get] ==================== default: AccessKeyID: LTA******************zUL AccessKeySecret: psM************************PSf AccountID: 158**********465 fc-console: AccountID: 176**********635 AccessKeyID: LTA******************W9G AccessKeySecret: cKL************************5Ra alifc: AccountID: 181**********700 AccessKeyID: LTA******************W9G AccessKeySecret: cKL************************5Ra ``` 如果想要获取某个已经配置的密钥详情，可以通过`s config get`进行获取，例如，想要获取别名为`default`的密钥信息，执行`s config get -a default`命令: ```bash 🚀 Result for [config get] ==================== default: AccessKeyID: LTA******************zUL AccessKeySecret: psM************************PSf AccountID: 158**********465 ``` 通过`s config delete`命令，您可以删除配置过的账号信息。执行`s config delete`或`s config delete -h/--help`命令 ```bash Usage: s config delete [options] You can delete an account. Example: $ s config delete -a demo 📖 Document: https://serverless.help/s/config#delete Options -a, --access Specify the access alias name -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | access | a | 选填 | 密钥的别名 | 操作案例：执行`s config delete -a demo`命令： * 成功： ```bash 🚀 Result for [config delete] ==================== Access [demo] has been successfully deleted. ``` * 失败： ```bash ❌ Result for [config delete] ==================== Error Message: Unable to get key information with alias demo, You have configured these keys: [default,fc-console,alifc,devs,default-baidu2,jjjj,default-1]. 👀 Get detail log: s cli runlog xxxxxxxxxx Env: darwin, node v15.14.0 Logs: ~/demo/demo/demo/s.log Get Help: DingTalk: xxxxxxxxxxx Feedback: https://feedback.serverless-devs.com ``` 通过`s config rename`命令，您可以更改配置过的密钥信息名称。执行`s config rename`或`s config rename -h/--help`命令: ```bash Usage: s config rename [options] You can rename an account. Example: $ s config rename -s source -t target 📖 Document: https://serverless.help/s/config#rename Options -s, --source Source alias name -t, --target Target alias name -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | source | s | 必填 | 原始密钥的别名 | | target | t | 必填 | 变更后密钥的别名 | 执行`s config rename -s demo1 -t demo2`命令： * 成功： ```bash 🚀 Result for [config rename] ==================== Alias: demo2 AccessKeyID: aaaa SecretAccessKey: aaa ``` * 失败： ```bash ❌ Result for [config rename] ==================== Error Message: Unable to get key information with alias demo, You have configured these keys: [default,fc-console,alifc,devs,default-baidu2,jjjj,default-1]. 👀 Get detail log: s cli runlog xxxxxxxxxx Env: darwin, node v15.14.0 Logs: ~/demo/demo/demo/s.log Get Help: DingTalk: xxxxxxxxxxx Feedback: https://feedback.serverless-devs.com ``` 通过`s config default`命令，可以配置默认密钥信息。执行`s config default`或`s config default -h/--help`命令 ```bash Usage: s config default [options] Specify an access as the default. Example: $ s config default $ s config default -a demo 📖 Document: https://serverless.help/s/config#default Options -a, --access Specify the access alias name -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | access | a | 选填 | 密钥的别名 | 执行`s config default`命令： ```bash You can choose an access to set as the default. ? Please select an access: (Use arrow keys) ❯ demo demo1 demo2 (Move up and down to reveal more choices) ``` 选择之后提示： ```bash 🚀 Result for [config default] ==================== Access [demo] has been set as default. ``` 如果失败，则提示： ```bash ❌ Result for [config default] ==================== Error Message: Unable to get key information with alias demo, You have configured these keys: [default,fc-console,alifc,devs,default-baidu2,jjjj,default-1]. 👀 Get detail log: s cli runlog xxxxxxxxxx Env: darwin, node v15.14.0 Logs: ~/demo/demo/demo/s.log Get Help: DingTalk: xxxxxxxxxxx Feedback: https://feedback.serverless-devs.com ``` 也可以通过执行`s config default -a demo`进行默认密钥的配置 ## init 命令 `init`命令是初始化Serverless项目的脚手架。通过`s init -h/--help`可以进入到帮助文档： ```bash Usage: s init [options] [name | url] Initialize a new project based on a template. You can initialize the application that conforms to the serverless devs project specification through GitHub, or you can initialize the application provided by the source by configuring the source. Example: $ s init $ s init project $ s init project -d my_dir $ s init project --appName my-express $ s init project --parameters '{"serviceName":"websiteService"}' $ s init git@github.com:foo/bar.git $ s init https://github.com/foo/bar.git 📖 Document: https://serverless.help/s/init 🚀 More applications: https://registry.serverless-devs.com Options: -d, --dir Where to output the initialized app into (default: ./ ) -r, --registry Use specify registry -a, --access Specify the access alias name. --parameters Initialize with custom parameters --app-name Modify default Application name -h, --help Display help for command ``` 参数解析 | 参数全称 | 参数缩写 | 默认取值 | 参数含义 | |----|----|----|----| | dir | d | `./` | 项目初始化的路径/目录 | | registry | -r | | 源配置地址，类似于Python中指定pip源，或者Node.js中指定NPM源 | | parameters | | {"serviceName":"websiteService"} | 初始化参数 | | app-name | | my-express | 应用/项目名称 | 执行`s init`命令，可以直接进入到交互模式 ```bash 🚀 More applications: https://registry.serverless-devs.com ? Hello Serverless for Cloud Vendors (Use arrow keys or type to search) ❯ Alibaba Cloud Serverless AWS Cloud Serverless Tencent Cloud Serverless Huawei Cloud Serverless Baidu Cloud Serverless Dev Template for Serverless Devs ``` 选则对应的厂商之后： ```bash 🚀 More applications: https://registry.serverless-devs.com ? Hello Serverless for Cloud Vendors Alibaba Cloud Serverless ? Hello, serverlesser. Which template do you like? (Use arrow keys or type to search) ❯ Quick start [Deploy a Hello World function to FaaS] Container example [Deploy function to FaaS with custom-container] Web Framework [Deploy a web framework to FaaS] Static website [Deploy a static website] Best practice [Experience serverless project] More example [Obtain more cases through Registry] ``` 选择最后一个`More example [Obtain more cases through Registry] `选项，可以进行入到 Registry 中，进行选择： ```bash 🚀 More applications: https://registry.serverless-devs.com ? Hello Serverless for Cloud Vendors Alibaba Cloud Serverless ? Hello, serverlesser. Which template do you like? More example [Obtain more cases through Registry] ? Which template do you like? ❯ Node.js 14 [alibaba][这是一个 Node.js 14 的描述] Node.js 14 [alibaba][这是一个 Node.js 14 的描述] Node.js 14 [alibaba][这是一个 Node.js 14 的描述] (Move up and down to reveal more choices) ``` * 直接初始化：通过`s init [name | url]`，可以从配置的`Registry`或者指定的仓库`Url`获取模板项目。 * 初始化 Registry 应用，以默认的`Registry`为例，可以初始化相对应的案例项目：`start-fc-http-nodejs12`，可以通过`s init start-fc-http-nodejs12`命令来进行： ```bash 🚀 More applications: https://registry.serverless-devs.com ? Please input your project name (init dir) start-fc-http-nodejs12 ✔ file decompression completed ...... 🚀 Result for [s init] ==================== template: start-fc-http-nodejs12 localdir: /user/demo 🍼 Tips ==================== You can [cd /Users/jiangyu/start-fc-http-nodejs14] and enjoy your serverless journey. If you need help for this example, you can use [s -h] after you enter folder. ``` * 初始化仓库应用以Github仓库 `https://github.com/devsapp/puppeteer-app` 为例，可以通过`s init git@github.com:devsapp/puppeteer-app.git`命令初始化该案例项目： ```bash More applications: https://registry.serverless-devs.com Cloning into 'puppeteer-app'... remote: Enumerating objects: 35, done. remote: Counting objects: 100% (35/35), done. remote: Compressing objects: 100% (23/23), done. remote: Total 35 (delta 10), reused 30 (delta 6), pack-reused 0 Receiving objects: 100% (35/35), 6.59 KiB | 3.30 MiB/s, done. Resolving deltas: 100% (10/10), done. 🚀 Result for [s init] ==================== template: git@github.com:devsapp/puppeteer-app.git localdir: /user/demo 🍼 Tips ==================== You can [cd /Users/jiangyu/start-fc-http-nodejs14] and enjoy your serverless journey. If you need help for this example, you can use [s -h] after you enter folder. ``` ## verify 命令 `verify`命令可以对Serverless应用格式进行校验。当执行`s verify -h`之后，可以进行相关帮助信息的查看： ```bash Usage: s verify Application verification. Example: $ s verify 📖 Document: https://serverless.help/s/verify Options: -t, --template [templatePath] Specify the template file -h, --help Display help for command ``` 参数解析 | 参数全称 | 参数缩写 | 默认取值 | 参数含义 | |----|----|----|----| | template | t | `s.yaml`/`s.yml` | 指定资源描述文件 | 操作案例可以通过`s verify`直接应用格式的校验： * 正确结果： ```bash ✅ Result for [s verify] ==================== Format verification passed. ``` * 错误结果： ```bash ❌ Result for [s init] ==================== Format verification failed. key Your Value Type Target Type Description CodeUri String Struct 参数描述 🍼 Tips ==================== You can obtain detailed Yaml specifications through document https://serverless.help/yaml You also can perform visual Yaml editing through the [s edit] command. ``` * 动态参数： ```bash ✴️ Result for [s init] ==================== Format validation unknown: key Your Value Type Target Type Description CodeUri String Struct 参数描述 🍼 Tips ==================== Dynamic parameters cannot be verified before operation, but this does not affect your continued deployment. If there are problems with the parameters, an error will be reported during deployment. ``` ## edit 命令 `edit`命令可以对Serverless应用编辑。当执行`s edit -h`之后，可以进行相关帮助信息的查看： ```bash Usage: s edit Application editing. Example: $ s edit 📖 Document: https://serverless.help/s/edit Options: -t, --template [templatePath] Specify the template file -h, --help Display help for command ``` 参数解析 | 参数全称 | 参数缩写 | 默认取值 | 参数含义 | |----|----|----|----| | template | t | `s.yaml`/`s.yml` | 指定资源描述文件 | > 注意：由于该功能需要确保电脑安装了相关的浏览器，因为该功能是可视化的资源编辑能力，需要浏览器的支持；原型图：【Yaml 和可视化，通过publish.yaml实现，Composer通过一个额外的hook进行配置】 ![image-20230508142032230](https://www.images.wiki/6lukdeCA5he8gshzsG21.png) 整体内容包括； 1. 支持全局配置，支持每个资源的配置（包括添加资源与删除当前资源）； 2. 支持组件选择，查看文档，可视化Yaml ## set 命令 `set`命令是对工具进行相关配置的命令。当执行`s set -h`之后，可以进行相关帮助信息的查看： ```bash Usage: s set [commands] [options] You can make some default settings for the tool here. 📖 Document: https://serverless.help/s/set Options: -h, --help Display help for command Commands: registry 👀 Set up a Serverless Devs registry language 📝 Set up Serverless Devs tools language proxy 🔧 Set up proxy analysis 👉 Set to enable or disable analysis log 🔊 Set up log config workspace 🙊 Set up Serverless Devs workspace ``` `set registry` 命令通过该命令，可以对 Serverless Devs 开发者工具进行 Registry 配置。执行`s set registry -h`命令，可以看到帮助文档 ```shell script Usage: s set registry [options] Set registry information. Example: $ s set registry $ s set registry http://registry.devsapp.cn/simple 📖 Document: https://serverless.help/s/set#registry Options: -h, --help Display help for command ``` 切换 Registry 的方法有两种： 1. 直接提供 Registry 信息，例如：`s set registry http://registry.devsapp.cn/simple` 2. 通过交互式方法，进行 Registry 信息的切换，`s set registry`： ```shell script 🔎 Current registry: http://registry.devsapp.cn/simple ? Choose a registry? (Use arrow keys) ❯ serverless registry [http://registry.devsapp.cn/simple] github registry [https://api.github.com/repos] gitee registry [http://gitee.registry.devsapp.cn/simple] custom registry ``` 此时，只需要选择对应的选项，就可以引导式的进行操作。 > 额外需要说明的是，虽然社区目前拥有Github Resitry， Gitee Registry， Serverless Registry等三个源，但是实际上这三个源也有着一定的逻辑关系： > > * Github Resitry：终极默认源，即无论用户配置了其他任何一个源，如果没有找到对应的内容，都会默认到该源进行查找； > * Gitee Registry：针对中国用户，与Gitee合作的国内源； > * \ > Serverless Registry：Serverless Devs社区的默认源，也将作为被默认配置的源； > 在Serverless Devs的开发者工具中，默认的加载逻辑： ![图片alt](https://www.images.wiki/z52DFAhqhwys3bEGqSD7.png) > 🙊 注：系统默认的 Registry 是：`serverless devs offical registry [http://registry.devsapp.cn/simple] ` `set language` 命令通过该命令，可以对修改 Serverless Devs 默认语言。执行`s set language -h`命令，可以看到帮助文档 ```shell script Usage: s set language [options] Set language. Example: $ s set language $ s set language zh $ s set language en 📖 Document: https://serverless.help/s/set#language Options -h, --help Display help for command ``` 设置语言的方法有两种： 1. 直接进行配置，例如：`s set language zh`或`s set language en`，既可以分别将 Serverless Devs 工具设置为中文界面和英文界面； 2. 通过交互式方法，进行配置`s set language`： ```shell script ? Choose a language? (Use arrow keys) ❯ 中文 English ``` `set proxy` 命令通过该命令，可以对 HTTP 请求设置全局代理。执行`s set proxy -h`命令，可以看到帮助文档 ```shell script Usage: s set proxy [options] Set proxy information. Example: $ s set proxy $ s set proxy --http_proxy xxxx:xxx --https_proxy xxxx:xxx $ s set proxy --enable false 📖 Document: https://serverless.help/s/set#proxy Options --enable Whether to enable proxy --http-proxy Specify the http_proxy. --https-proxy Specify the https_proxy. -h, --help Display help for command ``` 设置 proxy 的方法有两种： 1. 直接进行配置，例如：`s set proxy --http-proxy xxxx:xxx --https-proxy xxxx:xxx --enable` 2. 通过交互式方法，进行配置`s set proxy`： ```shell script ? Please enter http_proxy: xxxx:xxx ? Please enter https_proxy: xxxx:xxx ? Do you want to enable proxy Yes ``` `set analysis` 命令通过该命令，可以对 Serverless Devs 开发者工具的数据分析能力进行配置。执行`s set analysis -h`命令，可以看到帮助文档 ```shell script Usage: s set analysis [options] Set analysis action. Example: $ s set analysis $ s set analysis disable 📖 Document: https://serverless.help/s/set#analysis Options: -h, --help Display help for command ``` 设置 analysis 的方法有两种： 1. 直接进行配置，例如：`s set analysis disable` 2. 通过交互式方法，进行配置`s set analysis`： ```shell script 📝 Current analysis action: enable ? Choose a action? (Use arrow keys) ❯ enable disable ``` 此时，只需要选择对应的选项，就可以引导式的进行操作。 > 🙊 注：系统默认的 analysis 是：`enable` `set log` 命令通过该命令，可以对 Serverless Devs 开发者工具的写入日志能力进行配置。执行`s set log -h`命令，可以看到帮助文档 ```shell script Usage: s set log [options] Set log action. Example: $ s set log $ s set log disable 📖 Document: https://serverless.help/s/set#log Options: -h, --help Display help for command ``` 设置 log 的方法有两种： 1. 直接进行配置，例如：`s set log disable` 2. 通过交互式方法，进行配置`s set log`： ```shell script 📝 Current log action: enable ? Choose a action? (Use arrow keys) ❯ enable disable ``` 此时，只需要选择对应的选项，就可以引导式的进行操作。 > 🙊 注：系统默认的 log 是：`enable` `set workspace` 命令通过该命令，可以对 Serverless Devs 开发者工具的默认路径进行配置。执行`s set workspace -h`命令，可以看到帮助文档 ```shell script Usage: s set workspace [options] Set workspace path. Switching workspaces may make previously cached components and configured key information unavailable. Example: $ s set workspace $ s set workspace ~/.s 📖 Document: https://serverless.help/s/set#workspace Options: -h, --help Display help for command ``` 设置 workspace 的方法有两种： 1. 直接进行配置，例如：`s set workspace ~/.s` 2. 通过交互式方法，进行配置`s set workspace`： ```shell script 📝 Current workspace path: ~/.s 🙊 Switching workspaces may make previously cached components and configured key information unavailable. ? Please input an absolute path: ``` 此时，只需要选择对应的选项，就可以引导式的进行操作。 > 🙊 注：系统默认的 workspace 是：`~/.s` ## clean 命令 `clean`命令是清理 Serverless Devs 的缓存相关功能，可以通过该命令清理环境、不用的依赖包以及相关的缓存内容。当执行`s clean -h`之后，可以进行相关帮助信息的查看： ```shell script Usage: s clean [options] Clean up the cache related functions of serverless devs. You can clean up the environment, unused dependent packages and related cache contents through this command. Example: $ s clean --component fc-api $ s clean --all Tips: Get all installed component: s component 📖 Document: https://serverless.help/s/clean Options: --all Clean up the environment --cache [dirName] Delete the file in the cache --component [componentName] Remove component (like: fc, fc@0.0.1) -h, --help Display help for command ``` 参数解析： | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | all | | 选填 | 清理环境 | | cache | | 选填 | 删除缓存里的的文件 | | component | | 选填 | 删除指定的组件，可以是组件名，也可以是\[组件名@版本号\] | 操作案例：如果想要清理掉某个组件，可以通过`--component`参数与具体的组件名进行清理，例如`s clean --component fc-api`： ```shell script Component [fc-api] has been cleaned up successfully. ``` 如果想要清理整体环境，可以直接通过`--all`参数进行，例如`s clean --all `： ```shell script The environment of Serverless Devs has been cleaned up successfully. ``` 注意事项：在进行指定组件的清理时，系统会按照指定的逻辑进行组件的清理： 1. 系统先会确定当前设置的 Registry 缓存中，存在的符合条件的组件，并进行清理； 2. 系统将会对系统的最终 Registry 缓存中（Github Registry），存在的符合条件的组件，并进行清理； ## component 命令 `component`命令是获取已经安装的组件详情信息。当执行`s component -h`之后，可以进行相关帮助信息的查看： ```shell script Usage: s component [options] Get details of installed components. Example: $ s component $ s component --component fc-api 📖 Document: https://serverless.help/s/component Options: --component Gets the specified component information (like: fc, fc@0.0.1) -h, --help Display help for command ``` 参数解析 | 参数全称 | 参数缩写 | 是否必填 | 参数含义 | |----|----|----|----| | name | | 选填 | 获取指定的组件信息，可以是组件名，也可以是\[组件名@版本号\] | 操作案例：如果想要获取某个组件，可以通过`--component`参数与具体的组件名进行查询，例如： ```shell script Component: fc Reigstry: serverless registry [http://registry.devsapp.cn/simple] Version: 0.1.27 Size: 100 MB Description: 阿里云函数计算基础组件 Path: ~/.s/components/fc Hompage: https://github.com/devsapp/fc 🙋 Delete the component, please use the command [s clean --component fc@0.1.27] ``` 如果想要获取所有已经安装的组件信息，可以直接执行`s component`获取，例如： ```shell script 🔎 serverless registry [http://registry.devsapp.cn/simple] Component Description Size Version fc 阿里云函数计算基础组件 100 MB 0.1.27 devsapp/fc 阿里云函数计算基础组件 100 MB 0.1.27 fc-api 函数计算api操作组件 100 MB 0.0.44 🔎 github registry [https://api.github.com/repos] Component Description Size Version fc 阿里云函数计算基础组件 100 MB 0.1.27 devsapp/fc 阿里云函数计算基础组件 100 MB 0.1.27 ``` ## preview 命令 `preview`命令可以预览 Serverless Devs Yaml 渲染结果。当执行`s preview -h`之后，可以进行相关帮助信息的查看： ```shell script Usage: s preview Application priview. Example: $ s verpriviewify 📖 Document: https://serverless.help/s/verify Options: -t, --template [templatePath] Specify the template file -h, --help Display help for command ``` 参数解析 | 参数全称 | 参数缩写 | 默认取值 | 参数含义 | |----|----|----|----| | template | t | `s.yaml`/`s.yml` | 指定资源描述文件 | 操作案例可以通过`s priview`直接应用格式的校验： ```shell edition: 3.0.0/1.0.0 access: 密钥信息 validation: true resources: project_a: component: website # 组件名称 access: access # 密钥信息 extend: name: demo # 继承template中的指定key对应的结构，与props内容进行合并 ignore: # 忽略的属性 - name props: # 业务逻辑具体的属性 key: value name: aaaa project_b: component: website # 组件名称 props: # 业务逻辑具体的属性，外部的变量用()获取，呢不的变量用.获取，增加json参数，可以将外部字符串变为json格式 key_url: ${url(url地址)} key_env: ${env(环境变量)} key_file: ${file(文件路径)} ``` ## center 命令 `center`命令是登录开发中心的命令，通过当执行`s center -h`之后，可以进行相关帮助信息的查看： ``` Usage: s center [options] Visualization for project management. Example: $ s center 📖 Document: https://serverless.help/s/center Options: -h, --help Display help for command ``` 用户执行`s center`会自动拉起 Serverless Devs 应用中心开源版（Serverless CD） 1. 在项目下打开 s center，默认打开项目页面 2. 在通用目录下打开 s center，默认是 Serverless CD ## registry 命令 `registry`命令是将安利模板发到 Regsitry 并对相关内容进行管理的命令，通过当执行`s registry -h`之后，可以进行相关帮助信息的查看： ``` Usage: s registry [commands] [options] You can manage Serverless Packages on Serverless Registry. 📖 Document: https://serverless.help/s/registry Options: -h, --help Display help for command Commands: login 😃 Login Serverless Registry publish ✅ Public Serverless Package to Serverless Regsitry list 🐵 List the packages you have published detail 🌱 View specific package details delete ❌ Delete specific package ``` `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/s/registry#login Options: --token [toekn] Login by token --retoken Reset login token --get-token Get login token -h, --help Display help for command ``` 登陆有两种模式： * 模式1：已经拥有了登陆后的`token`信息，此时可以使用`s registry login --token `直接进行`token`的配置； * 模式2：没有登陆后的`token`信息，或者还没有注册过 Serverless Registry，此时可以通过`s registry login`直接打开浏览器，按照操作提示进行登录授权，当页面显示如下，即表示登陆成功： ![图片alt](https://www.images.wiki/2veaB1FZ2diBSeS25CDz.png) 如果因为某些情况，导致 Serverless Registry 的 Token 信息泄漏，此时可以通`s registry login --retoken`重置token，如果需要获取登陆token，可以执行`s registry login --get-token` `registry pubish` 命令通过该命令，可以将符合 Serverless Package 规范的项目下，可以通过 `publish` 命令，进行发布。执行`s registry publish -h`命令，可以看到帮助文档： ``` Usage: s registry publish [options] Login Serverless Registry. Example: $ s registry publish 📖 Document: https://serverless.help/s/registry#pubish Options: -h, --help Display help for command ``` 执行`s registry publish`之后，可以看到结果 * 正确结果： ```bash ✅ Result for [s registry publish] ==================== Publish success. ``` * 错误结果： ```bash ❌ Result for [s registry publish] ==================== xxxxxxxxx 🍼 Tips ==================== You can refer to the Serverless Package development specifications: https://serverless.help/s/dev ``` `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/s/registry#list Options: -h, --help Display help for command ``` 例如：`s registry list`: ``` - package: ros-test description: 通过阿里云 ROS 部署项目 version: 0.0.10 zipball_url: https://registry.devsapp.cn/simple/ros-test/zipball/0.0.10 - package: fc-core description: FC公共组件 version: 0.0.7 zipball_url: https://registry.devsapp.cn/simple/fc-core/zipball/0.0.7 - package: fc description: 阿里云函数计算基础组件 version: 0.1.38 zipball_url: https://registry.devsapp.cn/simple/devsapp/fc/zipball/0.1.38 ``` `registry detail` 命令通过该命令，可以查看指定 Package 的信息。执行`s registry detail -h`命令，可以看到帮助文档： ``` Usage: s registry detail [options] View application details. Example: $ s registry detail --name fc 📖 Document: https://serverless.help/s/registry#detail Options: -name Serverless Package name -h, --help Display help for command ``` 例如：`s registry list`: ``` PackageName: fc Versions: - tag_name: 0.1.38 published_at: '2022-01-18T03:32:08.511Z' zipball_url: https://registry.devsapp.cn/simple/fc/zipball/0.1.38 - tag_name: 0.1.37 published_at: '2022-01-07T07:57:17.327Z' zipball_url: https://registry.devsapp.cn/simple/fc/zipball/0.1.37 - tag_name: 0.1.36 published_at: '2022-01-04T13:53:16.579Z' zipball_url: https://registry.devsapp.cn/simple/fc/zipball/0.1.36 - tag_name: 0.1.35 published_at: '2021-12-30T07:30:11.873Z' zipball_url: https://registry.devsapp.cn/simple/fc/zipball/0.1.35 ``` `registry delete` 命令通过该命令，可以删除指定 Package 的指定版本。例如在某些情况下，发布版本出现故障，可以通过删除该版本进行回退操作。执行`s registry delete -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/s/registry#login Options: ---name-version Package name and version, like: fc@0.0.1 -h, --help Display help for command ``` 执行`s registry delete`之后，可以看到结果 * 正确结果： ```bash ✅ Result for [s registry delete] ==================== Delete success. ``` * 错误结果： ```bash ❌ Result for [s registry delete] ==================== xxxxxxxxx ``` ## cli 命令 `cli`命令是去 Yaml 化的命令行模式，即可以通过命令行直接使用 Serverless Devs 的组件，而不需要依赖 Yaml 文件。当执行`s cli -h`之后，可以进行相关帮助信息的查看： ```shell script Usage: s cli [component] [method] [options] Directly use serverless devs to use components, develop and manage applications without yaml configuration. Example: $ s cli fc-api listServices $ s cli fc-api listFunctions --service-name my-service $ s cli fc-api deploy -p "{/"function/": /"function-name/"}" 📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/cli.md Options: -a, --access [aliasName] Specify the access alias name -p, --props [jsonString] The json string of props -h, --help Display help for command ``` 使用方法主要是： ```shell script s cli [组件名称，例如fc，fc-api等] [组件的方法] -p/--props [该方法对应的Yaml属性（JSON字符串）] -a/--access [指定密钥信息] [其他设定] ``` 通用组件的支持：在`cli`模式下，可以通过`-p, --props [jsonString]`参数对组件进行通用的支持。例如，某 Serverless Devs 应用可以通过以下`s.yaml`描述： ```yaml edition: 3.0.0 access: "myaccess" resource: website-starter: component: website props: bucket: testbucket src: codeUri: ./ publishDir: ./build index: index.html region: cn-hangzhou hosts: - host: auto ``` 并且，可以通过`s website-starter deploy`，将`website-starter`部分进行部署。此时，如果通过`cli`模式进行部署，可以不需要依赖上述Yaml，但是需要在命令行中，写上完整的参数信息： ```shell script s cli website deploy -p "{\"bucket\":\"testbucket\",\"src\":{\"codeUri\":\"./\",\"publishDir\":\"./build\",\"index\":\"index.html\"},\"region\":\"cn-hangzhou\",\"hosts\":[{\"host\":\"auto\"}]}" -a myaccess ``` 特定组件的支持：在 Serverless Devs 目前已经存在的组件中，已经有一些比较优秀且针对 Cli 模式设计的组件，例如`fc-api`组件，就是一款命令行模式优先的组件，通过该组件，可以快速的使用阿里云函数计算的一些接口，进行操作，例如： * 查看阿里云函数计算的某个地区下某个服务下的函数列表： ```shell script s cli fc-api listFunctions --service-name my-service --region cn-beijing -a myaccess ``` * 通过纯命令行形式，对函数进行代码更新： ```shell script s cli fc-api updateFunction --region cn-hangzhou --serviceName fc-deploy-service --functionName http-trigger-function --code '{"zipFile":"./"}' ``` 除此之外，很多组件可以即对 Yaml 模式有比较好的支持，也会在某些情况下对纯命令行模式，进行额外优化设计，例如 `fc` 组件的线上线下资源同步操作： ```shell script s cli fc sync --region cn-shanghai --service-name myService --type config ``` ## 命令所谓的自定义命令指的是由组件决定的命令。由于 Serverless Devs 开发者工具，本身并不具备任何业务相关的能力（值得包括不限于函数的部署、应用的构建、项目的测试等），所以，这些能力都将会由组件提供，通过 Serverless Devs 开发者工具进行透出。例如，某应用的资源/行为描述文件如下： ```yaml resource: backend: # 服务名称 component: django-component # 组件名称 props: # 组件的属性值 src: ./backend_src url: url user—frontend: # 服务名称 component: vue-component # 组件名称 props: # 组件的属性值 src: ./frontend_src_user url: url admin-frontend: # 服务名称 component: vue-component # 组件名称 props: # 组件的属性值 src: ./frontend_src_admin url: url ``` 通过该 Yaml 文件可以看出以下信息： 1. 该应用的名字是`FullStack`，将会使用密钥`xxx-account1`; 2. 该应用拥有三个服务： * `backend`服务：使用了`django-component`组件 * `user—frontend`服务：使用了`vue-component`组件 * `admin-frontend`服务：使用了`vue-component`组件如果此时`django-component`组件和`vue-component`组件支持的自定义命令为： | | `django-component` | `vue-component` | |----|----|----| | `deploy` | 支持 | 支持 | | `remove` | 支持 | 支持 | | `test` | 支持 | 不支持 | 应用级操作在当前项目下，可以执行`s [自定义命令]`实现应用纬度的操作。 * 执行`s deploy`或者`s remove`时，由于`backend`、`user—frontend`、`admin-frontend`三个服务对应的组件，均支持`deploy`和`remove`方法，所以此时系统会按照Serverless User Model所定义的服务顺序，进行三个服务分别对应的组件的`deploy`或`remove`操作；**此时，系统的**`exit code`为0； * 执行`s test`时，由于`user—frontend`、`admin-frontend`两个服务对应的组件并不支持`test`方法，所以此时系统会执行`backend`对应组件（`django-component`）的`test`操作；**此时，系统会对**`user—frontend`、`admin-frontend`两个服务进行警告，但是并不会报错，最终的`exit code`为0； * 如果在执行相关的命令时，`backend`、`user—frontend`、`admin-frontend`三个服务任何一个服务在执行过程中出现了错误，系统则会报错，并终止下一步的操作，**此时，系统的**`exit code`为101；服务级操作在当前项目下，可以执行`s [服务名] [自定义命令]`实现服务级操作。 * 执行`s backend deploy`等，可以针对服务`backend`进行`deploy`相关的操作，**如果顺利完成与其操作，系统的**`exit code`为0；否则，出现错误，系统的`exit code`为101； * 执行`s admin-frontend test`是，由于服务`admin-frontend`对应的`test`方法是不存在的，**此时系统将会认为是未找到组件方法，系统的**`exit code`为100；注意事项在上面应用级操作和服务级操作中，不难发现，同样是某些组件不包括对应方法，但是在应用级操作和服务级操作中的表现形式却不同，这里的设计思路主要是为了保证应用级操作的流畅性。所以其规律通常如下： 1. 应用级操作更多是一种批量操作，会按照Serverless User Model所定义的服务顺序对应用下的所有服务进行分别操作；所以，此时如果出现某个服务对应的组件不包括当前方法，会以"批量操作"作为理由，跳过该服务，进行警告后继续执行，**此时，系统的**`exit code`为0； 2. 服务级操作更多是一种针对某个应用下的某个服务的特定操作，此时如果找不到对应的方法，则意味着本次操作没有意义，将会惊醒错误报告，**此时，系统的**`exit code`为100； \

Serverless Devs CLI 命令行规范