StackRivet 文档

StackRivet 是面向 AI 编码团队的 Spring Boot 和 Vue 应用基座。生成器可以预览并产出受治理的后端、管理端、权限、迁移和测试骨架，同时让 Claude Code、Cursor 和 Codex 始终在项目的架构、安全与测试规则内工作。

本文档是免费、Apache-2.0 的 Community（社区版）。第一次来？按顺序走下面五步——约一小时就能跑通并生成你的第一个模块。

你的第一个小时

1. 在本地跑起来 —— 启动数据存储、运行后端和管理后台，然后登录。 → 快速开始

2. 看它能干什么 —— 使用快速开始中全新本地数据库的种子账号登录，浏览开箱即带的模块；需要接口细节时，再拉取受认证保护的 OpenAPI 目录。在线 Demo 的访问方式与之分离，以其登录页说明为准。

3. 生成并落地第一个模块 —— 用产品内置生成器创建可审查的前后端模块包，再按手工落地教程接入 Maven、Flyway、Vue route 与 RBAC 菜单。 → 生成一个模块 和 生成模块手工落地实战

4. 部署一个最小应用 —— 构建后端 jar 和静态后台，设置必需的环境变量，再运行发布产物。 → 部署

5. 想深入 —— 跑通后，再学架构、安全模型和 AI 护栏。 → 核心概念

第一次？ 从第 1 步开始、别跳步——每步都建立在上一步之上。 已经熟 Spring Boot + Vue？ 直接跳到生成一个模块。

开箱即带什么

跑通之后，这是完整能力清单（当参考查，不是起点）：

能力域	内置
后端	Spring Boot 4.0 模块化单体（16 个 Maven 模块）、Spring Security、MyBatis-Plus、Flyway
前端	Vue 3.5、TypeScript、Vite、带 StackRivet 设计系统的 Element Plus
访问控制	RBAC、菜单 / 按钮 / API 权限、行级数据权限
代码生成	Entity、Mapper、Service、Controller、DTO/VO、前端页面、OpenAPI 与测试骨架
Asset Service	Local/S3/OSS、私有签名下载；默认中转，仅在能力接口声明时启用绑定字节数的 S3 直传/分片
可观测性	traceId、Actuator、Micrometer，可选 OpenTelemetry profile
AI 工程	AI 可读规则、模块边界，以及为 Codex / Cursor / Claude Code 生成的上下文
交付	Docker Compose、Dev Container、CLI doctor、SBOM 与发布清单

文档导航

• 入门 —— 跑起来、理解仓库结构、生成第一个模块。
• 核心概念 —— 架构、安全模型、Asset Service、异步任务与 AI 护栏。
• 指南 —— 生成模块、落地生成代码、新增权限、配置存储、部署。
• 参考 —— API 约定、CLI、配置项、数据库结构与工程标准。

版本

StackRivet 是开放内核。本 Community 版按 Apache-2.0 正式提供，免费且可商用。Team 与 Enterprise 当前是范围化设计伙伴试点；Roadmap 和合同能力会在价格页明确标注。