文档
开始使用
项目从本仓库的一份副本中生成,副本由插件下载或通过克隆获得。项目生成在该副本旁边,并自带 .claude/。
环境要求: JDK 21+gitcurlgh(可选,用于推送)
指南: /init-project/arch-adopt/platform-upgrade
新项目
A · 通过插件,无需克隆
- 安装插件,并在将要存放项目的目录中打开 Claude Code。
- 运行
/nerviz:new-project:它把最新 release 下载到nerviz-<tag>/,并打印要在那里打开的会话。 - 在该会话中接受 trust prompt,确认强制约束已生效,然后生成。
- 在生成的项目中打开新会话,提出第一个用例。
claude plugin marketplace add nerviz-ai/marketplace claude plugin install nerviz@nerviz cd ~/dev && claude # 将要存放项目的目录 › /nerviz:new-project # 把最新 release 下载到 nerviz-<tag>/ # 接受 trust prompt:hooks 保证架构 cd ~/dev/nerviz-<tag> && claude › /arch-doctor › /init-project --blueprint hexagonal --build maven --name my-api # 然后在生成的项目中开发 cd ~/dev/my-api && claude › /new-feature <第一个用例>
--ref <tag|sha|main>可固定其他版本。用同一个 tag 再次运行会复用该目录树;旧的nerviz-*目录只会被列为可安全删除,绝不会被删除。- 它拒绝在项目内运行(目录中有
pom.xml或build.gradle):在那里请用/nerviz:arch-adopt。 /init-project会写入目录树之外(../<artifactId>),因此会出现同级文件夹的权限提示。若想一次性批准,请先运行mkdir ~/dev/my-api和/add-dir ../my-api。
B · 通过克隆,贡献者的路径
- 在项目将要存放的位置旁边克隆,并在克隆目录中打开 Claude Code。
- 确认强制约束已生效,然后生成。
- 在生成的项目中打开新会话,提出第一个用例。
# 在项目将要存放的位置旁边克隆 cd ~/dev git clone --depth 1 https://github.com/nerviz-ai/nerviz cd nerviz && claude # 确认这台机器上的强制约束已生效 › /arch-doctor › /init-project --blueprint hexagonal --build maven --name my-api # 然后在生成的项目中开发 cd ../my-api && claude › /new-feature <第一个用例>
已有项目
同一个插件两种情况都适用:安装一次,然后在 Java 项目中执行 adopt。用 git diff 审查;用 git checkout -- .claude 撤销。
claude plugin marketplace add nerviz-ai/marketplace claude plugin install nerviz@nerviz # 在 Java 项目中 › /nerviz:arch-adopt
低于 Spring Boot 4.0:先运行 /platform-upgrade
/arch-adopt 拒绝 Spring Boot 线低于 4.0 的项目:export 在写入任何字节之前就以 2 退出。/platform-upgrade 是向上的路。它把构建带到 Initializr 今天提供的那条线,让构建保持绿色,diff 不提交,并在最后打印 /arch-adopt。
- 从干净的工作区开始,需要构建可接受的 JDK、项目根目录的 Maven 或 Gradle wrapper,以及访问 Initializr 和引擎仓库的网络。
- 在项目中运行
/nerviz:platform-upgrade。它只能手动运行:它会改写你的构建和源码,所以只在你点名调用时运行。 - 审查 diff,然后运行
/nerviz:arch-adopt。
# 在 Java 项目中,线低于 4.0 › /nerviz:platform-upgrade # 审查 diff,然后 adopt › /nerviz:arch-adopt/platform-upgrade 指南 →
需要了解的静默失败
| 症状 | 原因 | 检查 |
|---|---|---|
| hook 从不触发 | 在克隆目录打开的会话里开发 | 在生成的项目中打开 claude |
| hook 在所有系统上都失败 | java 不在 PATH 中 | /arch-doctor |
| Stop 时测试从不运行 | 没有 HEAD:拒绝了 git-publish 的第一个确认 | /arch-doctor |
文档目录
完整文档目前提供英文和葡萄牙文版本,以下链接指向英文版。