Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (yzw-openspec-cn) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

yzw-openspec-cn

OpenSpec 脚手架 — 一键初始化 AI 辅助开发工作流。

前置依赖

工具	用途	安装方式
Node.js >= 18	运行本脚手架	nodejs.org
opencode CLI	AI 开发工作流引擎	`npm install -g @opencode-ai/cli`
codegraph CLI	Java 代码结构索引	同上（同一 CLI）

脚手架运行时会自动检查 opencode 是否安装，未安装可一键安装。

安装

npm install -g yzw-openspec-cn

或用 npx 免安装：

npx yzw-openspec-cn

使用

yzw-openspec-cn init

按提示依次填写 6 组配置：

① 项目基础

字段	说明	示例
项目英文名	项目标识，用于目录和包命名	`crp`, `psc`, `contract`
项目中文名	用于知识库标题	`合同管理平台`
源码路径	Java 项目根目录绝对路径	`/home/user/java/crp`
包前缀	Java 包名前缀	`cn.yzw.jc.crp`
目标目录	生成的 OpenSpec 项目放在哪	`./service-crp`

② 构建环境

字段	默认值	说明
JDK 路径	`/path/to/jdk`	JDK 安装目录
Maven 路径	`/path/to/mvn`	mvn 命令路径
Maven settings	`~/.m2/settings.xml`	Maven 配置文件
代理地址	`http://127.0.0.1:10808`	网络代理（如 VPN）

③ 数据库

字段	默认值	说明
TiDB 主机	`localhost`	数据库地址
TiDB 端口	`4406`	数据库端口
TiDB 用户	`app_user`	数据库用户名
TiDB 库名	`{项目名}`	数据库名称

④ Elasticsearch

字段	默认值	说明
ES 地址	`localhost:9200`	ES 连接地址
ES 用户	`elastic`	ES 用户名

⑤ SSO 认证

字段	默认值	说明
SSO 地址	`https://sso.example.com/api/login`	登录接口
AppKey	`your_app_key`	应用标识
登录名	`admin`	SSO 账号

⑥ 应用配置

字段	默认值	说明
端口	`8080`	应用 HTTP 端口
Main 类	`Application`	启动主类
DevOps	`https://devops.example.com`	DevOps 平台地址

所有字段都有默认值，直接回车即可使用默认。 错误的配置后续可在 openspec/config.yaml 中修改。

管道模式（CI / 自动化）

printf 'crp\n\n/home/user/java/crp\ncn.yzw.jc.crp\n./service-crp\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n' | yzw-openspec-cn

每行对应一个字段，空行=使用默认值（顺序见上方 6 组表格）。

初始化后还需手动配置

以下文件含密码/Token/密钥，由开发者独立填写，不入版本库：

文件	需填写内容	参考模板
`.knowledge/config/profile.yaml`	数据库密码、SSO 密码、ES 密码、钉钉 Token、视觉模型 API Key	`profile.yaml.example`

cp .knowledge/config/profile.yaml.example .knowledge/config/profile.yaml
# 编辑 profile.yaml 填入真实凭据

初始化后生成什么

service-{name}/
├── AGENTS.md                  ← AI 工作流指令
├── opencode.json              ← OpenCode 配置（含 MCP CodeGraph）
│
├── .opencode/
│   ├── commands/              ← 10 个 opsx-* 工作流命令
│   ├── skills/                ← 20 个 AI 技能
│   └── package.json           ← plugin 依赖（首次 opencode 自动装）
│
├── openspec/
│   └── config.yaml            ← 项目全量配置（已填入 init 时输入的值）
│
├── .knowledge/
│   ├── INDEX.md               ← 知识索引
│   ├── config/
│   │   ├── profile.yaml        ← ⚠️ 需手动填入凭据
│   │   ├── profile.yaml.example← 凭据模板
│   │   └── build-guide.md      ← 编译启动指南（需补充 IDE 配置）
│   ├── business/               ← 业务领域模型（持续积累）
│   ├── tech/                   ← 编码 SOP / 开发经验 / 踩坑
│   ├── project/                ← 项目概览
│   ├── ops/                    ← 上线检查清单
│   └── risks/                  ← 已知风险记录
│
├── scripts/
│   └── knowledge-health-check.sh
│
└── .gitignore

快速上手

# 1. 进入生成的项目
cd ./service-crp

# 2. 启动 opencode（首次会自动装插件）
opencode

# 3. 学习项目 API 知识
/opsx-learn /api/path/example

# 4. 开始开发
/opsx-explore 分析这个需求...

工作流命令

命令	用途	前置条件
`/opsx-explore`	需求探索、原型分析	无
`/opsx-propose`	生成变更提案	需先 explore
`/opsx-apply`	实现变更任务	需先 propose
`/opsx-verify`	编译、启动、接口验证	需先 apply
`/opsx-deliver`	提交代码、部署上线	需先 verify
`/opsx-archive`	归档变更、知识沉淀	需先 deliver
`/opsx-learn`	全链路知识学习	无
`/opsx-health`	知识库健康巡检	无

发布到 npm

npm login
npm publish

许可

MIT