WARNING

# 当前文档已迁移到新的文档站点 (opens new window),此内容不再维护!

# CLI 配置文件

配置文件可以简化 CloudBase CLI 使用,方便项目开发,当使用命令参数缺省时,CloudBase CLI 会从配置文件中解析相关参数并使用,方便开发者以更简单的方式使用 CloudBase CLI。

默认情况下,使用 cloudbase init 初始化项目时,会生成 cloudbaserc.jscloudbaserc.json 文件作为配置文件,你也可以使用 --config-file 指定其他文件作为配置文件,文件必须满足格式要求。

# 字段

# envId

类型: String

envId 代表环境 ID,是环境的唯一标识。

# functionRoot

类型String

函数代码存放的文件夹路径,相对于项目根目录的路径。

# functions

类型Array<CloudFunction>

函数配置项组成的数组,有关函数配置项的详细信息,请参考函数配置项文档 (opens new window)

# 简单参考配置

下面是一个简单的 CLI 配置文件包含的基本信息:

{
    // 关联环境 ID
    "envId": "dev-xxxx",
    // 云函数文件夹名称,相对路径,可以省略 './
    "functionRoot": "functions",
    // 函数配置
    "functions": [
        {
            // functions 文件夹下函数文件夹的名称,即函数名
            "name": "app",
            // 函数配置
            "config": {
                // 超时时间,单位:秒 S
                "timeout": 5,
                // 环境变量
                "envVariables": {
                    "key": "value"
                }
            }
        }
    ]
}