小程序开放平台

文档中心
快速入门
开发准备
本地开发
本地开发函数服务
小红书云CLI工具
介绍
安装
快速开始
CLI命令行全览
命令概览
login/logout登录与账号管理
fun云函数调试
env云环境相关
agent智能命令行
命令组合使用示例
函数配置文件
部署发布
功能服务
常见问题

云函数调试

开发指南
>
本地开发
>
小红书云CLI工具
>
CLI命令行全览
>
fun云函数调试
>
更新时间:2026-01-09 11:27:01

rcb fun new
- 创建新的云函数项目

创建一个新的云函数项目模板,用于快速开始开发云函数应用。

命令格式

rcb fun new [options]

参数说明

参数
说明
是否必填
-p, --projectName <projectName>
指定项目名称
-d, --dir <dir>
指定项目创建的目标目录,默认为当前目录

使用示例

# 在当前目录创建名为 my-function 的项目
rcb fun new -p my-function

# 在指定目录创建项目
rcb fun new -p my-function -d ./projects

# 使用简写形式
rcb fun new --projectName my-function --dir ./projects

输出示例

📋 云函数项目创建信息
────────────────────────────────────────
创建目录:   /path/to/projects/my-function
目录名称:   my-function
────────────────────────────────────────

✓ 模板文件复制完成

✔️ 云函数项目创建成功: /path/to/projects/my-function
下一步操作:
  - cd /path/to/projects/my-function
  - npm install
  - npm run dev

说明

  • 项目名称不能为空
  • 如果目标目录已存在同名项目,会提示错误并退出
  • 创建的项目包含完整的云函数开发模板和配置文件
  • 创建完成后需要进入项目目录安装依赖并启动开发服务器

rcb fun dev
- 启动本地调试服务

在本地启动云函数调试服务,提供 Web IDE 界面进行代码编辑和调试。

命令格式

rcb fun dev [options]

参数说明

参数
说明
是否必填
-d, --dir <dir>
指定函数调试目录,默认为当前工作目录
-o, --open
启动后自动打开浏览器访问调试 UI
-e, --envId <envId>
指定云环境 Id,会校验环境是否存在并持久化配置
-w, --watch
启用文件监听模式,文件变化时自动刷新

使用示例

# 在当前目录启动函数调试
rcb fun dev

# 指定函数目录并自动打开浏览器
rcb fun dev -d ./functions/demo -o

# 指定云环境 ID
rcb fun dev -e env-7k2m9n4p

# 开启文件监听模式
rcb fun dev -w

# 组合使用多个参数
rcb fun dev -d ./functions -e env-7k2m9n4p -o -w

输出示例

🧪 [rcb-fun] 函数调试目录: /path/to/functions
🧪 [rcb-fun] 函数调试服务已启动
🧪 [rcb-fun] API URL: http://localhost:9230
🧪 [rcb-fun] WebSocket URL: ws://localhost:9230/ws
🧪 [rcb-fun] 调试 UI: http://localhost:9230
🧪 [rcb-fun] 函数框架服务(rcb-ff)URL: http://localhost:9000

启动函数调试

说明

  • 启动后会启动 API 服务、WebSocket 服务、Web IDE UI 和函数框架服务
  • 通过
    -e/--envId
    指定云环境时,会校验环境是否存在,并将环境信息持久化到登录配置中
  • 使用
    -w/--watch
    时,本地文件变更会自动同步到 Web IDE
  • 需要先完成登录:
    rcb login
  • 详细使用说明请参考云函数调试器使用指南

rcb fun deploy
- 部署函数到云端

将本地函数代码打包并部署到指定云环境。

命令格式

rcb fun deploy [options]

参数说明

参数
说明
是否必填
-e, --envId <envId>
目标云环境 Id
-d, --dir <dir>
函数代码所在目录,默认为当前目录
--includeNodeModules
包含本地 node_modules 目录(默认包含)
--excludeNodeModules
排除本地 node_modules 目录
--desc <desc>
部署描述信息,将透传到云端的 desc 字段

使用示例

# 部署到指定云环境
rcb fun deploy -e env-7k2m9n4p

# 指定函数目录
rcb fun deploy -e env-7k2m9n4p -d ./functions

# 排除 node_modules(推荐,依赖由云端管理)
rcb fun deploy -e env-7k2m9n4p --excludeNodeModules

# 包含 node_modules(不推荐,会增加包体积)
rcb fun deploy -e env-7k2m9n4p --includeNodeModules

# 添加部署描述
rcb fun deploy -e env-7k2m9n4p --desc "修复用户信息查询 bug"

输出示例

🚀 [rcb-fun] 当前命令: rcb fun deploy
🚀 [rcb-fun] 工作目录: /path/to/functions
🚀 [rcb-fun] 目标环境 Id: env-7k2m9n4p
🚀 [rcb-fun] 是否包含 node_modules: 否
🚀 [rcb-fun] 部署描述: 修复用户信息查询 bug
🚀 [rcb-fun] 正在打包并部署函数代码...
✓ 初始化检查...
✓ 检查登录状态...
✓ 部署预检通过
✓ 代码打包完成
✓ 文件上传成功
✓ 云端部署完成
🚀 [rcb-fun] 函数部署成功 ✅

说明

  • 部署流程包括:初始化检查 → 部署预检 → 代码打包 → 文件上传 → 云端部署
  • 代码打包时会自动排除
    .git
    node_modules/.cache
    等无关文件
  • 必须指定云环境 ID(
    -e/--envId
    ),需要先完成登录
  • 建议使用
    --excludeNodeModules
    ,让云端管理依赖
  • 部署前建议先在本地使用
    rcb fun dev
    进行调试

rcb fun list
- 查看函数列表(预留)

查看云环境下的函数列表(当前为占位实现)。

命令格式

rcb fun list [options]

参数说明

参数
说明
是否必填
-e, --envId <envId>
目标环境 Id(预留参数)

使用示例

# 查看所有云环境(预留)
rcb fun list

# 查看指定环境下的函数(计划支持)
rcb fun list -e env-7k2m9n4p

当前状态

目前命令仅输出占位信息,不会真正访问云端接口,后续版本会补全实际查询能力。