• 简体中文

      • nb init

      初始化当前工作区，让 coding agent 可以连接和使用 NocoBase。nb init 可以连接已有应用，也可以通过 Docker、npm 或 Git 安装一个新应用。

      用法

      nb init [flags]

      说明

      nb init 支持三种提示模式：

      • 默认模式：在终端中逐步填写。
      • --ui：打开本地浏览器表单完成引导流程。
      • --yes：跳过提示并使用默认值。此模式必须传入 --env <envName>，并会创建新的本地应用。

      默认情况下，nb init 会在初始化或恢复初始化时安装或更新 NocoBase AI coding skills。已经自行管理 skills，或在 CI、离线环境中运行时，可以使用 --skip-skills 跳过这一步。

      如果初始化在 env 配置保存后中断，可以使用 --resume 继续：

      nb init --env app1 --resume

      参数

      参数类型说明
      --yes, -yboolean跳过提示，使用 flags 和默认值
      --env, -estring本次初始化的 env 名称，--yes 和 --resume 模式必填
      --uiboolean打开浏览器可视化向导，不能和 --yes 同时使用
      --verboseboolean显示详细命令输出
      --skip-skillsboolean跳过初始化过程中安装或更新 NocoBase AI coding skills
      --ui-hoststring--ui 本地服务绑定地址，默认 127.0.0.1
      --ui-portinteger--ui 本地服务端口，0 表示自动分配
      --localestringCLI 提示和 UI 语言：en-US 或 zh-CN
      --api-base-url, -ustringNocoBase API 地址，包含 /api 前缀
      --auth-type, -astring认证方式：token 或 oauth
      --access-token, -tstringtoken 认证方式使用的 API key 或 access token
      --resumeboolean复用已保存的 workspace env config 继续初始化
      --lang, -lstring安装后 NocoBase 应用的语言
      --force, -fboolean重新配置已有 env，并在需要时替换冲突的运行资源
      --app-root-pathstring本地 npm/Git 应用源码目录，默认 ./<envName>/source/
      --app-portstring本地应用端口，默认 13000，--yes 模式会自动选择可用端口
      --storage-pathstring上传文件和托管数据库数据目录，默认 ./<envName>/storage/
      --root-usernamestring初始管理员用户名
      --root-emailstring初始管理员邮箱
      --root-passwordstring初始管理员密码
      --root-nicknamestring初始管理员昵称
      --builtin-db, --no-builtin-dbboolean是否创建 CLI 托管的内置数据库
      --db-dialectstring数据库类型：postgres、mysql、mariadb、kingbase
      --builtin-db-imagestring内置数据库容器镜像
      --db-hoststring数据库地址
      --db-portstring数据库端口
      --db-databasestring数据库名
      --db-userstring数据库用户
      --db-passwordstring数据库密码
      --fetch-sourceboolean安装前下载应用文件或拉取 Docker 镜像
      --source, -sstring获取 NocoBase 的方式：docker、npm 或 git
      --version, -vstring版本参数：npm 版本、Docker 镜像 tag 或 Git ref
      --replace, -rboolean目标目录已存在时替换
      --dev-dependencies, -Dbooleannpm/Git 安装时是否安装 devDependencies
      --output-dir, -ostring下载目标目录，或保存 Docker tarball 的目录
      --git-urlstringGit 仓库地址
      --docker-registrystringDocker 镜像仓库名，不含 tag
      --docker-platformstringDocker 镜像平台：auto、linux/amd64、linux/arm64
      --docker-save, --no-docker-saveboolean拉取 Docker 镜像后是否保存为 tarball
      --npm-registrystringnpm/Git 下载和依赖安装使用的 registry
      --build, --no-buildbooleannpm/Git 依赖安装后是否构建
      --build-dtsbooleannpm/Git 构建时是否生成 TypeScript 声明文件

      示例

      nb init
nb init --ui
nb init --env app1 --yes
nb init --env app1 --yes --skip-skills
nb init --env app1 --resume
nb init --env app1 --resume --skip-skills
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source npm --version alpha --app-port 13080
nb init --env app1 --yes --source git --version fix/cli-v2
nb init --ui --ui-port 3000

      相关命令