nb api 动态命令

除了 nb api resource 之外,nb api 下还有一组根据 NocoBase 应用 OpenAPI Schema 动态生成的命令。这些命令在首次运行 nb env addnb env update 时生成并缓存。

常见分组

命令分组说明
nb api acl权限管理:角色、资源权限和操作权限
nb api api-keysAPI Key 管理
nb api app应用管理
nb api authenticators认证管理:密码、短信、SSO 等
nb api data-modeling数据建模:数据源、数据表和字段
nb api file-manager文件管理:存储服务和附件
nb api flow-surfaces页面编排:页面、区块、字段和操作
nb api system-settings系统设置:标题、Logo、语言等
nb api theme-editor主题管理:颜色、尺寸和主题切换
nb api workflow工作流:自动化流程管理

实际可用分组和命令取决于连接的 NocoBase 应用版本和已启用插件。运行以下命令查看当前应用支持的命令:

nb api --help
nb api <topic> --help

请求体参数

带请求体的动态命令支持:

参数类型说明
--bodystringJSON 字符串形式的请求体
--body-filestringJSON 文件路径

--body--body-file 互斥。

环境选择

动态 API 命令支持 --env--yes

参数类型说明
--env, -estring要请求的 CLI env 名称;省略时使用当前 env
--yes, -yboolean当显式 --env 指向的 env 与当前 env 不一致时,跳过交互确认

只有在你显式传入 --env 时,CLI 才会检查它是否与当前 env 一致。如果显式指定了不同的 env,交互终端会先确认;在非交互终端或 AI agent 场景下,需要由你自己显式追加 --yes,或者先执行 nb env use <name> 再重试。

相关命令