跳到主要内容

本地运行

本地运行函数型云托管服务（不支持容器型云托管服务）

基本用法​

tcb cloudrun run [options]

命令行参数​

支持的命令行参数如下：

Options:
  --runMode <runMode>                          运行模式，可选值: normal(普通函数) | agent(函数式 Agent)，默认值: normal
  --agentId <agentId>                          在 agent 模式下需要提供 Agent ID 进行调试
  -e, --envId <envId>                          环境 ID
  --port <port>                                监听的端口，默认为 3000
  -w, --watch                                  是否启用热重启模式，如启用，将会在文件变更时自动重启服务，默认为 false
  --dry-run                                    是否不启动服务，只验证代码可以正常加载，默认为 false
  --logDirname <logDirname>                    日志文件目录，默认为 ./logs
  --functionsConfigFile <functionsConfigFile>  多函数定义配置文件，默认为 ./cloudbase-functions.json
                                               环境变量: FUNCTIONS_CONFIG_FILE
  --loadAllFunctions                           是否加载 "functionsRoot" 目录中的所有函数。默认为 false
  --extendedContext <extendedContext>          用于解析 context.extendedContext 的值。""表示该功能已关闭。默认值为 null
                                               示例：--extendedContext '{"a":1,"b":2}'
                                               环境变量：EXTENDED_CONTEXT
  --open-debug-panel <openDebugPanel>          是否打开调试面板，默认为 'true'
  -h, --help                                   查看命令帮助信息

运行模式示例​

1. normal 模式 (默认)​

普通函数模式，适用于常规函数运行场景：

# 基本用法
tcb cloudrun run -e env-123456

# 带热重启
tcb cloudrun run -e env-123456 -w

2. agent 模式​

函数式 Agent 模式，需要提供 Agent ID 进行调试：

# 基本 agent 模式
tcb cloudrun run --runMode agent --agentId ibot-agent-xxx -e env-123456

# agent 模式带热重启
tcb cloudrun run --runMode agent --agentId ibot-agent-xxx -e env-123456 -w

更多示例见：函数示例

环境变量​

在本地运行时，需在项目根目录下创建名为 .env.local 的配置文件（注意文件名以英文句点开头），并按 KEY=VALUE 的格式写入环境变量，示例如下：

# .env.local
API_KEY=your_api_key123

项目部署完成后，请在该云托管服务的管理控制台中完成环境变量的配置操作