跳到主要内容

本地运行

使用本地运行命令可以在开发环境中运行和调试函数型云托管服务(不支持容器型服务)。

基本用法

tcb cloudrun run -e <envId>

使用示例:

# 普通模式运行,默认端口 3000
tcb cloudrun run -e env-123456

# 指定端口运行
tcb cloudrun run -e env-123456 --port 8080

# 启用热重启模式,代码变更时自动重启
tcb cloudrun run -e env-123456 -w

# 验证代码是否可正常加载,不实际启动服务
tcb cloudrun run -e env-123456 --dry-run

# 加载指定目录下的所有函数
tcb cloudrun run -e env-123456 --loadAllFunctions

Agent 模式运行

tcb cloudrun run --runMode agent --agentId <agentId> -e <envId>

使用示例:

# 运行 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

# Agent 模式指定端口
tcb cloudrun run --runMode agent --agentId ibot-agent-xxx -e env-123456 --port 8080

命令行参数

参数说明必填
-e, --envId环境 ID
--runMode运行模式,可选值: normal(普通函数)、agent(函数式 Agent),默认为 normal
--agentIdAgent ID,在 agent 模式下必须提供agent 模式必填
--port监听端口,默认为 3000
-w, --watch启用热重启模式,文件变更时自动重启服务
--dry-run仅验证代码可正常加载,不实际启动服务
--logDirname日志文件目录,默认为 ./logs
--functionsConfigFile多函数定义配置文件路径,默认为 ./cloudbase-functions.json
--loadAllFunctions加载 functionsRoot 目录中的所有函数
--extendedContext用于解析 context.extendedContext 的 JSON 字符串,如 '{"a":1,"b":2}'
--open-debug-panel是否打开调试面板,默认为 true
-h, --help查看命令帮助信息

环境变量配置

在项目根目录下创建 .env.local 文件(注意文件名以英文句点开头),按 KEY=VALUE 格式配置环境变量:

# .env.local
API_KEY=your_api_key123
DATABASE_URL=mysql://localhost:3306/db

注意事项

  • 仅支持函数型云托管服务,不支持容器型服务
  • 使用 -w 参数时,代码变更会自动触发服务重启,便于开发调试
  • Agent 模式需要先创建 Agent 并获取 Agent ID
  • 环境变量配置仅在本地运行时生效,部署后需在控制台配置
  • 更多函数示例可参考:函数示例