luote-ai-work

罗忒 AI 工作流 — 忒科技 TF/TE 文档与可 @ 引用的七模块模板（npm 包）。

内容

| 类别 | 说明 | |------|------| | 工作流链路 | @rules → @data → @design → @app → @test → @logs，@tool 横切 | | 平台规则 | Cursor、Claude、Trae、Qoder 中英文规范（@rules/platform/） | | 前后端规范 | @rules/backend.md、@rules/frontend.md | | 文档站 | VitePress，本地 npm run docs:dev |

安装

npm install luote-ai-work

安装完成后会在项目根目录自动复制（无 @ 前缀）：

rules · data · design · app · test · logs · tool

其中 rules/ 含默认 platform/ 规范（core、cursor 等），可直接编辑 rules/project.md。

跳过：LUOTE_SKIP_INIT=1
强制覆盖已有目录：LUOTE_FORCE_MODULES=1 npm install

手动复制：

npx luote-ai-work setup

初始化 @app

| 场景 | 命令 | |------|------| | 本仓库（clone 后根目录 npm install） | 交互式 postinstall，或 npm run init | | 业务项目 | npm install 后自动复制七模块；npx luote-ai-work init 初始化 app/ |

跳过 postinstall：LUOTE_SKIP_INIT=1

| 选项 | 说明 | |------|------| | 1 | 空项目（frontend/、backend/ 占位） | | 2 | Vue 3 + TypeScript（罗忒顶栏模板，api/views/components/stores/router） | | 3 | Spring Boot 3（domain.po/dto/vo、Swagger、MyBatis-Plus） | | 4 | 全栈 |

npx luote-ai-work init
npx luote-ai-work init --choice=3
npx luote-ai-work init --force

接入业务项目

npm install luote-ai-work

将自动得到 rules、data、design、app、test、logs、tool（已存在则跳过；rules 会补齐缺失的 platform 默认规范）。

然后：

npx luote-ai-work init --choice=2

如需手动补复制：npx luote-ai-work setup

配置规则

1. 编辑 rules/project.md 填写技术栈与命令
2. 将 rules/platform/cursor.zh.md（或 cursor.en.md）粘贴至 IDE 规则配置
3. 对话中可写 @rules 表示模块，磁盘路径为 rules/

通过 exports 引用（Node ESM）

import { readFileSync } from 'node:fs'
import { createRequire } from 'node:module'
const require = createRequire(import.meta.url)
const core = readFileSync(require.resolve('luote-ai-work/rules/core.en'), 'utf8')
const backend = readFileSync(require.resolve('luote-ai-work/rules/backend'), 'utf8')

本地开发（本仓库）

npm install
npm run docs:dev

| 命令 | 说明 | |------|------| | npm run init | 初始化本仓库 @app | | npm run docs:dev | 文档开发服务 | | npm run docs:build | 构建静态站点至 docs/.vitepress/dist | | npm run docs:preview | 预览构建结果 |

发布 npm

npm login
npm publish

发布前执行 prepublishOnly 校验文档构建。包内不含 node_modules 与构建缓存。

Agent

见仓库根目录 AGENTS.md。

许可证

MIT