Skip to content

CLI 命令索引 ​

下列命令均加前缀 ./kaiwu,在入口仓运行。大写参数替换为实际值,方括号表示可选项,斜线分隔备选命令或参数,实际执行时只选其中一种。首次体验从安装开始。

运行平台 ​

命令用途
doctor检查 Git、Docker Compose 等运行条件。
repositories预览取仓来源及版本策略。
init [--with-deploy]取回运行仓,可选一并获取部署仓。
up [--build / --no-build]启动平台;发行版默认拉镜像,--build 从源码构建。
dev用 Docker 跑基础设施,本机进程跑应用。
status查看容器状态。
logs [--tail N] [-f]查看最近日志,-f 持续跟随。
local-status / local-logs / local-down查看、跟踪或停止本机应用进程。
credentials在本机查看初始管理员凭据。
context-public-key输出业务后端验签所用的网关公钥。
reload-routes重新加载本机 Compose 受管路由。
down / resetdown 停止并保留数据;reset 确认后删除本地平台数据。
deploy-init / help获取可选 GitOps 仓;显示入口帮助。

会话与业务项目 ​

命令用途
login [--client NAME] [--local]设备授权;--local 尝试本机免点击。远程由账号本人确认。
whoami / logout查看身份或撤销 CLI 会话。
project new CODE --name NAME [--package PKG] [--description TEXT]登记项目并生成一次基础脚手架。
project status CODE [--wait]查看进度,可等待生成结束。
project pull CODE [--dir DIR]下载、解压前后端并初始化两个 Git 仓。
project adopt FRONTEND [--apply]登记已有产品前端、同步清单与首次角色,并生成配套后端仓(ADOPT_FRONTEND)。
project-up BACKEND [FRONTEND]构建业务项目并接入本机平台。
project-down CODE停止该业务栈,保留数据。
project entry CODE LABEL SERVICE_URL登记业务入口名称和服务根地址。
project sync MANIFEST_REPO [--apply] [--with-access]预览或同步 kaiwu/*.yml(支持后端仓或纳管后的前端仓);角色变更需显式加 --with-access。
workflow sync FRONTEND [--apply]预览或导入业务前端 kaiwu/workflows/ 流程清单(需启用兼容 Workflow 服务)。

成员与授权 ​

命令用途
access members CODE / access roles CODE / access permissions CODE列出成员、角色或可授予的权限。
access role-create CODE ROLE --name NAME [--description TEXT]创建项目角色。
access role-grant CODE ROLE (--permissions p1,p2 / --clear)整体替换角色授权,--clear 清空。
access member-set CODE USER --roles r1,r2 [--disabled]设置成员的完整角色集合,默认启用;--disabled 停用。
access member-remove CODE USER移除项目成员。

产品与业务前端常用命令 ​

下列命令在 kaiwu-web-starter 初始化仓或项目工厂生成的前端仓内执行:

命令用途
node scripts/kaiwu-init.mjs --code CODE --name NAME [--example booking]在 kaiwu-web-starter 初始化独立业务前端仓(默认空白,可选 booking 示例)。
pnpm dev默认 Mock 模式启动开发服务,访问 /__mock/ 切换演示身份并重置内存数据。
pnpm dev:real关闭 Mock 并代理 /api、/{code}-api、/{code}-svc 到 KAIWU_GATEWAY(默认 http://127.0.0.1:8088)。
pnpm verify:mock产品阶段全量自检:类型、字典、接入层 SHA-256、规则/场景/Mock 绑定、日志脱敏、约束与生产构建隔离。
pnpm verify联调阶段全量自检:运行 verify:mock 并检查权限。配套后端在默认相邻目录,或设置 KAIWU_SERVICE_DIR 时,会逐码核对服务端注解。须查看实际输出确认完成三端比较。
pnpm test:scenarios / pnpm test:browser执行 HTTP 验收场景 / 启动独立 Mock 跑 Chromium 交互验收。
pnpm test:proxy默认用回显服务校验请求路径与项目头;设置 KAIWU_GATEWAY 时核对真实网关响应。
sh scripts/check-runtime-image.sh "$IMAGE" CODE在已构建的生产前端镜像内校验首页与 /__mock/ 返回 404。

System 启动器扩展 ​

以下命令前缀为 ./workspace/kaiwu-system-service/scripts/kaiwu.sh。local-up 连接已配置的 Nacos 环境;storage accounts 列账号,storage bindings [CODE] 查绑定,storage test ACCOUNT 写入并删除探测对象。storage bind CODE --account ACCOUNT 支持 --name、--max-mb 和 --types;storage bind-status ID --status ACTIVE 可设置 ACTIVE、READ_ONLY 或 DISABLED。按步骤绑定

远程 CLI 用 KAIWU_URL 选择平台;用 KAIWU_REPOSITORY_REF 固定取仓版本,Fork 使用 KAIWU_REPOSITORY_BASE_URL 指定仓库组。

Apache License 2.0