phj-spec
v0.0.3
Published
AI 辅助开发的结构化规范,专为 Cursor IDE 设计。提供 plan / implement / archive 工作流。
Maintainers
Readme
phj-spec
面向 Cursor IDE 的 AI 辅助开发结构化规范,提供「规划 → 实现 → 归档」的规范与命令,类似 open-spec、speckit 等规范工作流。
安装
npm i -g phj-spec初始化
在项目根目录执行:
phj-spec init或(若提示 command not found,可用):
npx phj-spec init若全局安装后仍提示 phj-spec: command not found:多半是 npm 全局 bin 目录未加入 PATH。
- 查看全局 bin 路径:
npm bin -g(如 Windows 常见为C:\Users\你的用户名\AppData\Roaming\npm)。 - 将该目录加入系统环境变量 PATH,或直接使用
npx phj-spec init无需配置 PATH。
将会在项目下生成:
.cursor/commands/- 仅包含以
phj-spec开头的命令定义:phj-spec.plan.md、phj-spec.implement.md、phj-spec.archive.md
- 仅包含以
.cursor/template/plan-template.md、implement-template.md、archive-template.md— 规范模板
在 Cursor 中使用
在 Cursor 的 AI 对话框输入 /,可看到并执行:
| 命令 | 说明 |
|------|------|
| /phj-spec.plan | 在项目下创建 phj-spec 目录(若无则新建),并生成或更新 phj-spec/plan.md |
| /phj-spec.implement | 仅根据 phj-spec/plan.md 在代码库中实现功能,不生成 implement.md |
| /phj-spec.archive | 在项目下创建 phj-spec 目录(若无则新建),并生成或更新 phj-spec/archive.md,同时将当前 plan 按年/季/月归档到 .cursor/archive/ |
推荐流程
- 运行
/phj-spec.plan,与 AI 确认需求后生成或更新phj-spec/plan.md。 - 运行
/phj-spec.implement,由 AI 按phj-spec/plan.md的任务列表实现代码(不产生 implement.md)。 - 迭代结束后运行
/phj-spec.archive,生成或更新phj-spec/archive.md并将 plan 归档,便于下一轮规划。
协议
MIT
