@serverless-devs/s 2.0.96 → 2.0.97-beta.1

package/docs/zh/command/component.md

@@ -1,75 +0,0 @@
-# Component 命令
-
-`component`命令是获取已经安装的组件详情信息。
-
-- [命令解析](#命令解析)
-    - [参数解析](#参数解析)
-    - [操作案例](#操作案例)
-- [注意事项](#注意事项)
-
-## 命令解析
-
-当我们执行`s component -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-$ s component -h
-Usage: s component [options]
-
-Get details of installed components.
-    
-    Example:
-        $ s component
-        $ s component --component fc-api
-
-📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/component.md
-
-Options:
-  --component [componentName]     Gets the specified component information (like: fc, fc@0.0.1)
-  -h, --help                      Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| name |  | 选填 | 获取指定的组件信息，可以是组件名，也可以是[组件名@版本号] |
-
-### 操作案例
-
-如果想要获取某个组件，可以通过`--component`参数与具体的组件名进行清理，例如：
-
-```shell script
-$ s component --component fc-api
-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
-$ s component 
-
-🔎 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
-
-```
-
-
-## 注意事项
-
-在查询组件时，系统只会显示当前 Registry 与默认的 Github Reigstry 信息。如果需要查看其他 Reigstry 的信息，需要先通过`s set registry`进行 Reigstry 的切换

package/docs/zh/command/config.md

@@ -1,274 +0,0 @@
-# Config 命令
-
-`config`命令是密钥信息相关的命令，包括密钥的配置、密钥的查看以及密钥的修改、删除等。
-
-- [命令解析](#命令解析)
-- [config add 命令](#config-add-命令)
-    - [参数解析](#参数解析)
-    - [操作案例](#操作案例)
-- [config get 命令](#config-get-命令)
-    - [参数解析](#参数解析-1)
-    - [操作案例](#操作案例-1)
-- [config delete 命令](#config-delete-命令)
-    - [参数解析](#参数解析-2)
-    - [操作案例](#操作案例-2)
-- [注意事项](#注意事项)
-    - [通过环境变量设置密钥](#通过环境变量设置密钥)
-    - [关于配置密钥的使用顺序](#关于配置密钥的使用顺序)
-    
-## 命令解析
-
-当执行`s config -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-Usage: s config [commands] [options]
-
-Configure venders account, including Alibaba Cloud, Baidu Cloud, Huawei Cloud, Tencent Cloud, etc.
-
-📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/config.md
-
-Options:
-  -h, --help  Display help for command
-
-Commands:
-  add         ➕ Add an account
-  get         ✔️ Get accounts
-  delete      ✖️ Delete an account
-```
-
-在该命令中，包括了三个子命令：
-- [add：添加密钥配置](#config-add-命令)
-- [get：查看密钥配置](#config-get-命令)
-- [delete：删除密钥配置](#config-delete-命令)
-
-
-## config add 命令
-
-通过`config add`命令，可以进行密钥的配置，使用者可以通过不同厂商的默认密钥模板进行密钥配置，也可以通过`Custom`选项进行自定义密钥配置。
-
-通过`-h/--help`可以查看到配置帮助：
-
-```shell script
-Usage: s config add [commands] [name]
-
-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: AccountID, AccessKeyID, AccessKeySecret
-        aws: AccessKeyID, SecretAccessKey
-        baidu: AccessKeyID, SecretAccessKey
-        huawei: AccessKey, SecretKey
-        google: PrivateKeyData
-        tencent: AccountID, SecretID, SecretKey
-
-🧭 How to get the key: https://github.com/Serverless-Devs/docs/tree/master/zh/others/provider-config
-
-Options:
-  --AccountID [AccountID]              AccountID of key information
-  --AccessKeyID [AccessKeyID]          AccessKeyID of key information
-  --AccessKeySecret [AccessKeySecret]  AccessKeySecret of key information
-  --SecurityToken [SecurityToken]      SecurityToken of key information
-  --SecretAccessKey [SecretAccessKey]  SecretAccessKey of key information
-  --AccessKey [AccessKey]              AccessKey of key information
-  --SecretKey [SecretKey]              SecretKey of key information
-  --SecretID [SecretID]                SecretID of key information
-  --PrivateKeyData [PrivateKeyData]    PrivateKeyData of key information
-  -kl , --keyList [keyList]            Keys of key information, like: -kl key1,key2,key3
-  -il , --infoList [infoList]          Values of key information, like: -il info1,info2,info3
-  -a, --access [aliasName]             Key pair alias, if the alias is not set, use default instead
-  -f                                   Mandatory overwrite key information
-  -h, --help                           Display help for command
-```
-
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| AccountID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| AccessKeyID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| AccessKeySecret | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| SecurityToken | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| SecretAccessKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| AccessKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| SecretKey | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| SecretID | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| PrivateKeyData | - | 选填 | 部分云厂商配置密钥所需要的默认字段 |
-| keyList | kl | 选填 | 在默认字段无法满足配置诉求时，可以通过`keyList`与`infoList`进行批量自定义配置 |
-| infoList | il | 选填 | 在默认字段无法满足配置诉求时，可以通过``keyList`与`infoList`进行批量自定义配置 |
-| access | a | 选填 | 密钥的别名 |
-| f | - | 选填 | 强制修改/覆盖已经配置的密钥信息 |
-
-### 操作案例
-
-可以通过`config add`直接进行密钥的添加：
-
-```shell script
-$ s config add 
-
-? Please select a provider: (Use arrow keys)
-❯ Alibaba Cloud (alibaba) 
-  AWS (aws) 
-  Azure (azure) 
-  Baidu Cloud (baidu) 
-  Google Cloud (google) 
-  Huawei Cloud (huawei) 
-  Tencent Cloud (tencent) 
-  Custom (others) 
-```
-
-当使用者选择某个选项之后，系统会进行交互式引导：
-
-```shell script
-s config add 
-
-? Please select a provider: Alibaba Cloud (alibaba)
-? AccountID **********
-? AccessKeyID **********
-? AccessKeySecret **********
-? Please create alias for key pair. If not, please enter to skip default
-```
-
-也可以通过命令式直接进行密钥的添加：
-```shell script
-$ s config add --AccessKeyID ****** --AccessKeySecret ****** --AccountID ******
-```
-
-或者添加自定义内容：
-```shell script
-$ s config add --AccessKeyID ****** -kl key1,key2,key3 -il info1,info2,info3
-```
-
-- 常见云厂商密钥配置内容
-
-```
-alibaba:    AccountID, AccessKeyID, AccessKeySecret,
-aws:        AccessKeyID, SecretAccessKey,
-baidu:      AccessKeyID, SecretAccessKey,
-huawei:     AccessKeyID, SecretAccessKey,
-azure:      KeyVaultName, TenantID, ClientID, ClientSecret,
-tencent:    AccountID, SecretID, SecretKey,
-google:     PrivateKeyData
-```
-
-> - 通过环境变量获取密钥方法： 这一部分可能会根据不同的文档有不同的可能性，所以需要参考对应的文档进行环境变量对应的`Key-Value`确定。
-> - 常见云厂商密钥获取地址：
->     - [阿里云](./../default_provider_config/alibabacloud.md)
->     - [百度云](./../default_provider_config/baiducloud.md)
->     - [AWS](./../default_provider_config/aws.md)
->     - [Azure](./../default_provider_config/azure.md)
->     - [Google Cloud](./../default_provider_config/gcp.md)
->     - [华为云](./../default_provider_config/huaweicloud.md)
->     - [腾讯云](./../default_provider_config/tencentcloud.md)
-
-## config get 命令
-
-通过`config get`命令，您可以获得配置过的账号信息。
-
-通过`-h/--help`可以查看到配置帮助：
-
-```shell script
-$ s config get -h
-
-Usage: s config get [options] [name]
-
-You can get accounts.
- 
-     Example:
-        $ s config get
-        $ s config get -a demo
- 
-
-Options:
-  -a, --access [aliasName]  Key pair alia, if the alias is not set, use default instead
-  -h, --help                Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| access | a | 选填 | 密钥的别名 |
-
-### 操作案例
-
-如果想要获取某个已经配置的密钥详情，可以通过`config get`进行获取，例如，想要获取别名为`test`的密钥信息，就可以执行：
-
-```shell script
-$ s config get -a test
-test:
-  AccountID: 146**********468
-  AccessKeyID: LTA******************f5Q
-  AccessKeySecret: qDN************************Xp7
-```
-
-如果想获得全部的一配置的密钥信息，可以直接通过`config get`不加参数的形式获取：
-
-```shell script
-$ s config get
-default:
-  AccountID: 158**********465
-  AccessKeyID: LTA******************ZCW
-  AccessKeySecret: mDL************************odO
-test:
-  AccountID: 146**********468
-  AccessKeyID: LTA******************f5Q
-  AccessKeySecret: qDN************************Xp7
-release:
-  AccountID: 176**********635
-  AccessKeyID: LTA******************Yy3
-  AccessKeySecret: LhT************************VB5
-```
-
-## config delete 命令
-
-通过`config delete`命令，您可以删除配置过的账号信息。
-
-通过`-h/--help`可以查看到配置帮助：
-
-```shell script
-$ s config delete -h
-
-Usage: s config delete [options] [name]
-
-You can delete an account.
-
-     Example:
-        $ s config delete -a demo
-
-
-Options:
-  -a, --access [aliasName]  Key pair alias, if the alias is not set, use default instead
-  -h,--help                 Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| access | a | 必填 | 密钥的别名 |
-
-### 操作案例
-
-如果想要删除某个已经配置的密钥，可以通过`config delete`进行删除，例如，想要删除别名为`test`的密钥信息，就可以执行：
-
-```shell script
-$ s config delete -a test
-Key [test] has been successfully removed
-```
-
-## 注意事项
-
-### 通过环境变量设置密钥
-
-详情可以参考：[开发者工具设计文档](../tool.md) 中的 [通过环境变量设置密钥](../tool.md#通过环境变量设置密钥)
-
-### 关于配置密钥的使用顺序
-
-详情可以参考：[开发者工具设计文档](../tool.md) 中的 [通过环境变量设置密钥](../tool.md#密钥使用顺序与规范)

package/docs/zh/command/custom.md

@@ -1,73 +0,0 @@
-# 自定义命令使用指南
-
-- [应用级操作](#应用级操作)
-- [服务级操作](#服务级操作)
-- [注意事项](#注意事项)
-
-所谓的自定义命令指的是由组件决定的命令。由于 Serverless Devs 开发者工具，本身并不具备任何业务相关的能力（值得包括不限于函数的部署、应用的构建、项目的测试等），所以，这些能力都将会由组件提供，通过 Serverless Devs 开发者工具进行透出。
-
-例如，某应用的资源/行为描述文件如下：
-
-```yaml
-edition: 1.0.0        #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: FullStack       #  项目名称
-access: xxx-account1
-
-services:
-  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所定义的服务顺序](../../../spec/zh/0.0.1/serverless_user_model/3.user_model.md#服务顺序)，进行三个服务分别对应的组件的`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；**
-
-> 关于Serverless Devs开发者工具，涉及到的 Exit Code，可以参考[开发者工具设计文档](../tool.md)
-
-## 服务级操作
-
-在当前项目下，可以执行`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所定义的服务顺序](../../../spec/zh/0.0.1/serverless_user_model/3.user_model.md#服务顺序)对应用下的所有服务进行分别操作；所以，此时如果出现某个服务对应的组件不包括当前方法，会以"批量操作"作为理由，跳过该服务，进行警告后继续执行，**此时，系统的`exit code`为0；**
-2. [服务级操作](#服务级操作)更多是一种针对某个应用下的某个服务的特定操作，此时如果找不到对应的方法，则意味着本次操作没有意义，将会惊醒错误报告，**此时，系统的`exit code`为100；**

package/docs/zh/command/init.md

@@ -1,149 +0,0 @@
-# Init 命令
-
-`init`命令是初始化Serverless项目的脚手架。
-
-- [前言](#前言)
-- [命令解析](#命令解析)
-    - [参数解析](#参数解析)
-    - [初始化项目](#初始化项目)
-        - [引导式初始化](#引导式初始化)
-        - [直接初始化](#直接初始化)
-            - [初始化Registry应用](#初始化Registry应用)
-            - [初始化仓库应用](#初始化仓库应用)
-
-## 命令解析
-
-当执行`s init -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-$ s init -h
-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 git@github.com:foo/bar.git
-        $ s init https://github.com/foo/bar.git
-        
-🚀 More Application: https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/awesome.md
-
-Options:
-  -d, --dir [dir]       Where to output the initialized app into (default: ./<ProjectName> )
-  -r, --registry [url]  Use specify registry
-  -h, --help            Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 默认取值 | 参数含义 |
-|-----|-----|-----|-----|
-| dir | d | `./<ProjectName>` | 项目初始化的路径/目录 | 
-| registry | -r | http://registry.devsapp.cn/simple | 源配置地址，类似于Python中指定pip源，或者Node.js中指定NPM源 | 
-
-### 初始化项目
-
-#### 引导式初始化
-
-通过`s init`可以直接进入项目初始化的引导模块：
-
-```shell script
-$ s init
-
-🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
-
-? Hello Serverless for Cloud Vendors (Use arrow keys or type to search)
-❯ Alibaba Cloud Serverless 
-  AWS Cloud Serverless 
-  Baidu Cloud Serverless 
-  Huawei Cloud Serverless 
-  Tencent Cloud Serverless 
-  Dev Template for Serverless Devs 
-```
-
-此时只需要选择对应的选项，按照引导进行操作，即可。例如选择`Alibaba Cloud Serverless`，就可以看到阿里云Serverless产品下的应用模板分类:
-
-```shell script
-? Please select an Serverless-Devs Application (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] 
-```
-
-此时可以继续选择某分类下的具体应用进行初始化，例如选择`fc-runtime-starter`之后，可以看到该分类下的具体模板应用：
-
-```shell script
-? Which template do you like? (Use arrow keys or type to search)
-❯ [HTTP] Node.js 12 
-  [HTTP] Python3 
-  [HTTP] Java8 
-  [HTTP] PHP7 
-  [HTTP] C++ (custom) 
-  [Event] Node.js 12 
-  [Event] Python3 
-(Move up and down to reveal more choices)
-```
-
-选择`fc-http-nodejs`即可完成创建：
-
-```shell script
-$ s init                                         
-
-🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
-
-? Hello Serverless for Cloud Vendors Alibaba Cloud Serverless
-? Please select an Serverless-Devs Application fc-runtime-starter - 快速部署一个 FC 函数
-? Please select an templete fc-http-nodejs - 快速部署一个 nodejs12 http函数
-
-......
-
-💞 Document ❤ Star：https://github.com/Serverless-Devs/Serverless-Devs
-```
-
-更多关于默认源对应的应用信息，可以参考[Package Awesome](https://github.com/Serverless-Devs/package-awesome)
-
-#### 直接初始化
-
-通过`s init [name | url]`，可以从配置的`Registry`或者指定的仓库`Url`获取模板项目。
-
-##### 初始化Registry应用
-
-以默认的`Registry`为例，可以初始化相对应的案例项目：`start-fc-http-nodejs12`，可以通过`s init start-fc-http-nodejs12`命令来进行：
-
-```shell script
-$ s init start-fc-http-nodejs12
-
-🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
-
-? Please input your project name (init dir) start-fc-http-nodejs12
-✔ file decompression completed
-
-......
-
-💞 Document ❤ Star：https://github.com/Serverless-Devs/Serverless-Devs
-```
-
-##### 初始化仓库应用
-
-以Github仓库 `https://github.com/devsapp/puppeteer-app` 为例，可以通过`s init git@github.com:devsapp/puppeteer-app.git`命令初始化该案例项目：
-
-```shell script
-$ s init git@github.com:devsapp/puppeteer-app.git
-
-🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
-
-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.
-```
-
-
-

package/docs/zh/command/readme.md

@@ -1,76 +0,0 @@
-# 命令操作文档
-
-- [前言](#前言)
-- [全局参数](#全局参数)
-- [命令详情](#命令详情)
-    - [config: 密钥配置](./config.md)
-    - [init: 项目初始化](./init.md)
-    - [cli: 纯命令行模式](./cli.md)
-    - [clean: 工具清理](./clean.md)
-    - [component: 组件信息](./component.md)
-    - [set: 工具配置](./set.md)
-    - [custom: 自定义命令](./custom.md)
-
-## 前言
-
-Serverless Devs 可以通过`-h`唤起对应命令的帮助文档，例如查看 `s` 命令的帮助信息可以是：`s -h`
-
-当使用者使用命令行工具时，可以通过`s`命令，查看整体帮助信息:
-
-```shell script
-$ s
-Usage: s [options] [command]
-
-  _________                               .__
- /   _____/ ______________  __ ___________|  |   ____   ______ ______
- \_____  \_/ __ \_  __ \  \/ // __ \_  __ \  | _/ __ \ /  ___//  ___/
- /        \  ___/|  | \/\   /\  ___/|  | \/  |_\  ___/ \___ \ \___ \
-/_________/\_____>__|    \_/  \_____>__|  |____/\_____>______>______>
-
-Welcome to the Serverless Devs.
-
-More: 
-📘 Documents: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs
-🙌 Discussions: https://github.com/Serverless-Devs/Serverless-Devs/discussions
-📦 Applications: https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/awesome.md
-
-Quick start:
-🍻 Can perform [s init] fast experience
-
-Options:
-  -t, --template [templatePath]  Specify the template file
-  -a, --access [aliasName]       Specify the access alias name
-  --skip-actions                 Skip the extends section
-  --debug                        Open debug model
-  -v, --version                  Output the version number
-  -h, --help                     Display help for command
-
-Commands:
-  config                         👤 Configure venders account.
-  init                           💞 Initializing a serverless project.
-  cli                            🐚 Command line operation without yaml mode.
-  set                            🔧 Settings for the tool.
-  clean                          💥 Clean up the environment.
-  component                      🔌 Installed component information.
-```
-
-## 全局参数
-
-| 参数全称 | 参数缩写 | 默认取值 | 参数含义 | 备注 |
-|-----|-----|-----|-----|-----|
-| template | t | `s.yaml`/`s.yml` | 指定资源描述文件 | 可选`yaml`和`JSON`两种格式 | 
-| access | a | `yaml`中所指定的`access`信息/`default` | 指定本次部署时的密钥信息 | 可以使用通过[config命令](./command/config.md#config-add-命令)配置的密钥信息，以及[配置到环境变量的密钥信息](./command/config.md#通过环境变量配置密钥信息) | 
-| skip-actions | - | - | 跳过`yaml`所设置的`actions`模块 | - | 
-| debug | - | - | 开启`Debug`模式 | 开启`Debug`模式后可以查看到更多的工具执行过程信息 | 
-| version | v | - | 查看版本信息 | - | 
-| help | h | - | 查看帮助信息 | - | 
-
-## 命令详情
-
-- [config: 密钥配置](./config.md)
-- [init: 项目初始化](./init.md)
-- [cli: 纯命令行模式](./cli.md)
-- [clean: 工具清理](./clean.md)
-- [set: 工具配置](./set.md)
-- [component: 组件信息](./component.md)
-- [custom: 自定义命令](./custom.md)