@domoinc/da CLI 是用于搭建 Domo 自定义应用和生成样板代码的命令行工具,是创建新 Domo 应用和生成组件的推荐方式。
用途 DA CLI 提供:项目脚手架,创建结构正确的 Domo 应用(Vite + React 18 + TypeScript);代码生成,按 Domo 规范生成组件、Reducer 及其他样板;清单管理,管理不同环境的 manifest 配置;最佳实践,确保项目从一开始就遵循 Domo 约定。
安装 使用 pnpm:pnpm add -g @domoinc/da;或使用 npm:npm install -g @domoinc/da。
创建新应用 运行 da new my-app-name 创建新 Domo 应用,然后 cd my-app-name。也支持自定义模板:da new my-app --template @myorg/custom-template、--template github.com/user/repo、--template ./local-template。
生成的项目结构包含 public/manifest.json(Domo 应用配置)、public/thumbnail.png(Domo 中的应用图标)、src/components/(React 组件)、src/reducers/(Redux 切片,如使用)、src/services/(API 服务层)、src/types/(TypeScript 定义)、src/index.tsx(应用入口)、package.json 和 vite.config.ts。
代码生成 生成组件:da generate component MyComponent(简写 da g component MyComponent),会创建 MyComponent.tsx、MyComponent.module.scss、MyComponent.test.tsx、MyComponent.stories.tsx。生成 Redux 切片:da generate reducer myFeature(简写 da g reducer myFeature),会创建 src/reducers/myFeature/slice.ts,并自动导入到 store。
清单管理 DA CLI 帮助管理多个 Domo 环境(dev、staging、prod)。可创建环境专属 manifest 覆盖:da manifest instance.prod "Production on customer.domo.com"、da manifest instance.dev "Development on dev.domo.com";发布前应用覆盖:da apply-manifest instance.prod,然后 yarn upload。覆盖文件结构示例为以 instance.prod 为键,包含 description 和 manifest(如 id、proxyId)。
将生成的应用(Lovable/v0)转换为 Domo 许多开发者用 Lovable、v0 等 LLM 生成器创建应用原型,但这些工具通常生成服务端渲染(SSR)应用,与 Domo 仅客户端架构不兼容。生成的应用常见 SSR(Next.js、Remix、SvelteKit、Nuxt)、API 路由(pages/api/ 或 app/api/)、服务端数据获取(getServerSideProps、loader 等)、框架专属路由。Domo 应用必须是纯客户端 React、基于静态文件(Domo 只提供静态文件)、通过 Domo API(domo.get()、Query、AppDBClient 等)集成数据而非后端端点。
DA CLI 不是转换工具,不会自动转换应用,但可作为参考结构和起点。推荐转换流程:第一步,生成参考结构(da new my-converted-app);第二步,检测并移除 SSR 代码(如 getServerSideProps、getStaticProps、loader/action、+page.server.js、+server.js、pages/api/ 或 app/api/ 目录、服务端 process.env、组件中的数据库连接);第三步,替换数据获取,用 ryuu.js 的 domo.get('/data/v1/sales')、@domoinc/query 的 Query 或 @domoinc/toolkit 的 AppDBClient.DocumentsClient 替代 fetch 与 API 路由;第四步,更新路由,使用 react-router-dom 的 HashRouter,Domo 内部导航用 domo.navigate();第五步,修正构建配置,vite.config.js 中设置 base: './' 并启用 react 插件;第六步,移植组件,用 da generate component SalesChart 生成结构后复制逻辑、替换数据获取并更新导入。
DA CLI 帮助的内容:参考结构、组件生成、模式示例、在转换过于复杂时从新项目开始移植逻辑。DA CLI 不做的事:不自动转换(不把 SSR 转成客户端)、没有迁移向导、不做代码变换(不重写框架专属代码)、不做 API 迁移(不自动替换后端调用)。
完整转换检查清单:检测并移除所有 SSR 代码;移除 API 路由;把对后端的 fetch() 替换为 Domo API;路由更新为 HashRouter;Vite 配置 base: './';替换环境变量(改用 Domo API);更新导入(移除 Next.js/Remix 专属);测试所有数据获取在 Domo API 下可用;验证应用可在本地构建运行;发布到 Domo 并在平台内测试。
示例:转换一个简单仪表板。原 Lovable/Next.js 版本使用 getServerSideProps 从后端 fetch 销售数据并作为 props 传入 Dashboard;转换后的 Domo 版本在 React 组件中用 useEffect 和 domo.get('/data/v1/sales') 在客户端获取数据并存入 state 渲染。