跳转到内容

常用命令

先确认终端所在目录。核心工作区、独立业务应用与文档仓库的命令作用范围不同。

以下命令由已发布开发包提供;在线安装前先按快速开始配置读取凭据。

命令用途
pnpm core:install --version <X.Y.Z>首次安装或重装配套核心;首次在线安装还需私有源参数
pnpm core:upgrade --version <X.Y.Z>从已保存的线上源升级到更高的已发布精确版本,不运行迁移
pnpm core:login在用户配置目录保存私有 npm 包读取凭据
pnpm server:go <Go 参数>进入 server 并设置私有源环境,执行 Go 命令
pnpm core:deps按锁文件 frozen 重装前端依赖并设置发布时间豁免,不更新锁文件
pnpm core:tooling-upgrade把旧模板工具迁移到当前 Node ESM 工具
pnpm app:setup首次启动数据库并初始化密钥、迁移与种子
pnpm app:upgrade --plan/--force --json应用数据升级:执行迁移、baseline 与菜单同步,不更新依赖、不自动授权
pnpm dev:all确保数据库就绪,并在单终端启动前后端
pnpm build构建应用前后端
pnpm services:stop停止数据库容器并保留数据
pnpm install:example安装随附示例依赖(仅离线 file: 源模板使用)
node scripts/online.mjs restore恢复中断更新的依赖和配置,随后须重装旧版本

升级前先备份;失败恢复的适用条件见升级核心包。

0.13.0 开发包自带上述全部 Node ESM 命令(core:login、core:install、core:upgrade、core:deps、core:tooling-upgrade、app:setup、app:upgrade、dev:all、services:stop 等),不依赖 Python。仅 0.7.1 及更早的旧应用需先经 core:tooling-upgrade 迁移工具;core:upgrade 只更新核心依赖,不会把新版模板命令添加到旧应用。

命令用途
docker compose up -d启动本地 PostgreSQL 与 Redis
pnpm install --frozen-lockfile按唯一工作区锁文件安装
pnpm --filter @modu/web build构建前端核心库
pnpm dev运行 starter 前端
pnpm build依次构建核心库与 starter
pnpm create:example <新目录>从源码构建随附私有产物的独立 example(Python 脚本)
pnpm create:online <新目录> --version <X.Y.Z>维护者生成在线应用并安装已发布核心
pnpm core:login在用户配置目录保存私有 npm 包读取凭据
pnpm release:sources准备私有源码发行内容(Python 脚本)
pnpm release:pack打包发行资产
pnpm test:files-consumer校验 files 消费场景
pnpm test:acceptance运行打包验收测试
pnpm ci:local本地执行核心 CI 套件(ci:tools 仅工具套件)

下表展示在 server/ 执行的 Go 原命令。下载包用户在应用根目录统一通过 pnpm server:go 调用,例如 pnpm server:go run ./cmd/modu check,由包装脚本设置当前私有源;核心工作区联合开发可直接执行表中命令。

命令用途
go run .运行应用
go run . artisan migrate执行前向迁移
go run . artisan db:seed首次开发时初始化种子
go run ./cmd/modu new-extension sample创建应用扩展骨架
go run ./cmd/modu catalog generate生成前端 catalog
go run ./cmd/modu catalog check检查 catalog 与装配一致
go run ./cmd/modu doctor静态装配诊断
go run ./cmd/modu check检查源码、安装集合与配套版本
go run ./cmd/modu upgrade --plan/--force应用数据升级(app:upgrade 的 Go 入口)
go run ./cmd/modu build-maintenance生成构建维护产物
go run ./cmd/modu access-policy --plan/--apply访问策略计划或应用(readiness 做只读就绪检查)
go run ./cmd/modu authorization install显式安装统一授权(另有 catalog、availability、maintainers、set-availability 子命令)
go build ./... / go vet ./...编译与静态检查
go test ./...在已配置的测试环境中执行测试
命令用途
pnpm dev前端开发服务
pnpm lint / pnpm typecheck风格与类型检查
pnpm test应用测试
pnpm build生产构建
pnpm extension:check检查扩展声明、binding 与导入边界
pnpm extension:verify-build构建后检查真实 chunk 与预算
命令用途
pnpm dev --background启动后台文档开发服务
pnpm exec astro dev stop停止后台服务
pnpm verify类型检查、静态构建、链接与搜索测试
pnpm preview预览 dist,包含完整搜索索引

Pagefind 索引在构建时生成,开发服务不能替代完整搜索验收。