openspec-cn 0.23.1 → 1.0.0

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2024 OpenSpec Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+MIT License
+
+Copyright (c) 2024 OpenSpec Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -1,33 +1,94 @@
 <p align="center">
-  <a href="https://github.com/Fission-AI/OpenSpec">
+  <a href="https://github.com/xiangagou163/OpenSpec-cn">
     <picture>
-      <source srcset="assets/openspec_pixel_dark.svg" media="(prefers-color-scheme: dark)">
-      <source srcset="assets/openspec_pixel_light.svg" media="(prefers-color-scheme: light)">
-      <img src="assets/openspec_pixel_light.svg" alt="OpenSpec logo" height="64">
+      <source srcset="assets/openspec_bg.png">
+      <img src="assets/openspec_bg.png" alt="OpenSpec logo">
     </picture>
   </a>
   
 </p>
 <p align="center">面向 AI 编码助手的规范驱动开发。</p>
 <p align="center">
-  <a href="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
-  <a href="https://www.npmjs.com/package/@fission-ai/openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@fission-ai/openspec?style=flat-square" /></a>
-  <a href="https://nodejs.org/"><img alt="node version" src="https://img.shields.io/node/v/@fission-ai/openspec?style=flat-square" /></a>
+  <a href="https://github.com/xiangagou163/OpenSpec-cn/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/xiangagou163/OpenSpec-cn/actions/workflows/ci.yml/badge.svg" /></a>
+  <a href="https://www.npmjs.com/package/openspec-cn"><img alt="npm version" src="https://img.shields.io/npm/v/openspec-cn?style=flat-square" /></a>
+  <a href="https://nodejs.org/"><img alt="node version" src="https://img.shields.io/node/v/openspec-cn?style=flat-square" /></a>
   <a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
   <a href="https://conventionalcommits.org"><img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" /></a>
   <a href="https://discord.gg/YctCnvvshC"><img alt="Discord" src="https://img.shields.io/badge/Discord-Join%20the%20community-5865F2?logo=discord&logoColor=white&style=flat-square" /></a>
 </p>
 
+<details>
+<summary><strong>最受欢迎的规范框架。</strong></summary>
+
+[![Stars](https://img.shields.io/github/stars/xiangagou163/OpenSpec-cn?style=flat-square&label=Stars)](https://github.com/xiangagou163/OpenSpec-cn/stargazers)
+[![Downloads](https://img.shields.io/npm/dm/openspec-cn?style=flat-square&label=Downloads/mo)](https://www.npmjs.com/package/openspec-cn)
+[![Contributors](https://img.shields.io/github/contributors/xiangagou163/OpenSpec-cn?style=flat-square&label=Contributors)](https://github.com/xiangagou163/OpenSpec-cn/graphs/contributors)
+
+</details>
+<p></p>
+我们的理念：
+
+```text
+→ 流动而非僵化
+→ 迭代而非瀑布
+→ 简单而非复杂
+→ 面向存量系统而非只为从零开始
+→ 可从个人项目扩展到企业规模
+```
+
+> [!TIP]
+> **新工作流已上线！** 我们使用新的工件驱动工作流重建了 OpenSpec。
+>
+> 运行 `/opsx:onboard` 开始使用。→ [了解更多](docs/opsx.md)
+
 <p align="center">
-  <img src="assets/openspec_dashboard.png" alt="OpenSpec dashboard preview" width="90%">
+  关注 <a href="https://x.com/0xTab">@0xTab</a> 获取更新 · 进入 <a href="https://discord.gg/YctCnvvshC">OpenSpec Discord</a> 获取帮助与答疑。
 </p>
 
+### 团队
+
+在团队中使用 OpenSpec？请 <a href="mailto:teams@openspec.dev">邮件联系</a> 获取 Slack 频道访问权限。
+
+<!-- TODO: Add GIF demo of /opsx:new → /opsx:archive workflow -->
+
+## 实际演示
+
+```text
+你: /opsx:new add-dark-mode
+AI:  已创建 openspec/changes/add-dark-mode/
+     准备创建：proposal
+
+你: /opsx:ff   # "fast-forward" - 生成所有规划文档
+AI:  ✓ proposal.md — 为什么做、改什么
+     ✓ specs/       — 需求与场景
+     ✓ design.md    — 技术方案
+     ✓ tasks.md     — 实现清单
+     准备开始实现！
+
+你: /opsx:apply
+AI:  正在实现任务...
+     ✓ 1.1 添加主题上下文 Provider
+     ✓ 1.2 创建切换组件
+     ✓ 2.1 添加 CSS 变量
+     ✓ 2.2 接入 localStorage
+     任务全部完成！
+
+你: /opsx:archive
+AI:  已归档到 openspec/changes/archive/2025-01-23-add-dark-mode/
+     规范已更新。准备开始下一个功能。
+```
+
+<details>
+<summary><strong>OpenSpec Dashboard</strong></summary>
+
 <p align="center">
-  关注 <a href="https://x.com/0xTab">@0xTab</a> 获取更新 · 进入 <a href="https://discord.gg/YctCnvvshC">OpenSpec Discord</a> 获取帮助与答疑。
+  <img src="assets/openspec_dashboard.png" alt="OpenSpec dashboard preview" width="90%">
 </p>
 
+</details>
+
 <p align="center">
-  <sub>🧪 <strong>新功能：</strong> <a href="docs/experimental-workflow.md">实验性工作流（OPSX）</a> — 以 schema 驱动、可定制、可流动。无需改代码即可迭代工作流。</sub>
+  <sub>🧪 <strong>新功能：</strong> <a href="docs/opsx.md">OPSX 工作流</a> — 以 schema 驱动、可定制、可流动。无需改代码即可迭代工作流。</sub>
 </p>
 
 # OpenSpec
@@ -159,12 +220,12 @@ openspec --version
 
 无需安装，直接运行 OpenSpec：
 ```bash
-nix run github:Fission-AI/OpenSpec -- init
+nix run github:xiangagou163/OpenSpec-cn -- init
 ```
 
 或安装到你的 profile：
 ```bash
-nix profile install github:Fission-AI/OpenSpec
+nix profile install github:xiangagou163/OpenSpec-cn
 ```
 
 或在 `flake.nix` 中加入开发环境：
@@ -172,7 +233,7 @@ nix profile install github:Fission-AI/OpenSpec
 {
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
-    openspec.url = "github:Fission-AI/OpenSpec";
+    openspec.url = "github:xiangagou163/OpenSpec-cn";
   };
 
   outputs = { nixpkgs, openspec, ... }: {
@@ -190,13 +251,9 @@ openspec --version
 
 #### 第二步：在项目中初始化 OpenSpec
 
-进入你的项目目录：
-```bash
-cd my-project
-```
-
-运行初始化：
+进入你的项目目录并运行初始化：
 ```bash
+cd your-project
 openspec init
 ```
 
@@ -210,13 +267,20 @@ openspec init
 - 运行 `openspec list` 验证设置并查看活跃变更
 - 如果编码助手没有立刻显示命令，请重启。命令在启动时加载，重新启动即可出现。
 
+告诉你的 AI：`/opsx:new <你要构建的内容>`
+
+> [!NOTE]
+> 不确定工具是否支持？查看 [支持工具清单](docs/supported-tools.md) – 已支持 20+ 工具并持续增加。
+>
+> 也支持 pnpm、yarn、bun 与 nix。详见 [安装选项](docs/installation.md)。
+
 ### 可选：补充项目上下文
 
 `openspec init` 完成后，你会看到一段建议提示，用于补充项目上下文：
 
 ```text
-Populate your project context:
-"Please read openspec/project.md and help me fill it out with details about my project, tech stack, and conventions"
+补充你的项目上下文：
+"请阅读 openspec/project.md，并帮我填写项目细节、技术栈与约定"
 ```
 
 使用 `openspec/project.md` 定义项目级规范、标准、架构模式以及在所有变更中应遵循的准则。
@@ -407,10 +471,10 @@ OpenSpec 将单个功能的所有变更收拢到一个目录（`openspec/changes
 
 1. **升级包**
    ```bash
-npm install -g openspec-cn@latest
+   npm install -g openspec-cn@latest
    ```
 2. **刷新代理指令**
-- 在每个项目内运行 `openspec update`，重新生成 AI 指引并确保最新命令生效。
+   - 在每个项目内运行 `openspec update`，重新生成 AI 指引并确保最新命令生效。
 
 ## 实验性功能
 
@@ -446,27 +510,47 @@ npm install -g openspec-cn@latest
 
 **启用：** `openspec experimental`
 
-[完整文档 →](docs/experimental-workflow.md)
+[完整文档 →](docs/opsx.md)
 
 </details>
 
-<details>
-<summary><strong>遥测</strong> – OpenSpec 收集匿名使用统计（可退出：<code>OPENSPEC_TELEMETRY=0</code>）</summary>
+## 使用注意事项
 
-我们只收集命令名与版本号用于理解使用模式，不含参数、路径、内容或个人信息。CI 中会自动关闭。
+**模型选择**：OpenSpec 在高推理模型上表现更好。建议 Opus 4.5 与 GPT 5.2 用于规划与实现。
 
-**退出：** `export OPENSPEC_TELEMETRY=0` 或 `export DO_NOT_TRACK=1`
-
-</details>
+**上下文卫生**：在开始实现前清理上下文，过程中保持良好上下文卫生。
 
 ## 参与贡献
 
+**小改动** — 修复 Bug、改错别字或小改进可直接提交 PR。
+
+**大改动** — 新功能、较大重构或架构变更请先提交 OpenSpec 变更提案，先对齐意图与目标再实现。
+
+撰写提案时请牢记 OpenSpec 的理念：服务于不同编码助手、模型与使用场景，改动应对所有人友好。
+
+**欢迎 AI 生成代码** — 但需经过测试与验证。PR 中请注明使用的编码助手与模型（例如：“Generated with Claude Code using claude-opus-4-5-20251101”）。
+
+### 开发
+
 - 安装依赖：`pnpm install`
 - 构建：`pnpm run build`
 - 测试：`pnpm test`
 - 本地开发 CLI：`pnpm run dev` 或 `pnpm run dev:cli`
 - 规范化提交（单行）：`type(scope): subject`
 
+## 其他
+
+<details>
+<summary><strong>遥测</strong></summary>
+
+OpenSpec 收集匿名使用统计。
+
+我们只收集命令名与版本号用于理解使用模式，不含参数、路径、内容或个人信息。CI 中会自动关闭。
+
+**退出：** `export OPENSPEC_TELEMETRY=0` 或 `export DO_NOT_TRACK=1`
+
+</details>
+
 <details>
 <summary><strong>维护者与顾问</strong></summary>
 
@@ -476,4 +560,4 @@ npm install -g openspec-cn@latest
 
 ## 许可证
 
-MIT
+MIT

package/bin/openspec.js

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
+#!/usr/bin/env node
+
 import '../dist/cli/index.js';

package/dist/commands/feedback.js

@@ -59,10 +59,10 @@ function generateMetadata() {
     const version = getVersion();
     const platform = getPlatform();
     const timestamp = getTimestamp();
-    return `---
-Submitted via OpenSpec CLI
-- Version: ${version}
-- Platform: ${platform}
+    return `---
+Submitted via OpenSpec CLI
+- Version: ${version}
+- Platform: ${platform}
 - Timestamp: ${timestamp}`;
 }
 /**

package/dist/commands/schema.js

@@ -795,74 +795,74 @@ export function registerSchemaCommand(program) {
 function createDefaultTemplate(artifactId) {
     switch (artifactId) {
         case 'proposal':
-            return `## Why
-
-<!-- Describe the motivation for this change -->
-
-## What Changes
-
-<!-- Describe what will change -->
-
-## Capabilities
-
-### New Capabilities
-<!-- List new capabilities -->
-
-### Modified Capabilities
-<!-- List modified capabilities -->
-
-## Impact
-
-<!-- Describe the impact on existing functionality -->
+            return `## Why
+
+<!-- Describe the motivation for this change -->
+
+## What Changes
+
+<!-- Describe what will change -->
+
+## Capabilities
+
+### New Capabilities
+<!-- List new capabilities -->
+
+### Modified Capabilities
+<!-- List modified capabilities -->
+
+## Impact
+
+<!-- Describe the impact on existing functionality -->
 `;
         case 'specs':
-            return `## ADDED Requirements
-
-### Requirement: Example requirement
-
-Description of the requirement.
-
-#### Scenario: Example scenario
-- **WHEN** some condition
-- **THEN** some outcome
+            return `## ADDED Requirements
+
+### Requirement: Example requirement
+
+Description of the requirement.
+
+#### Scenario: Example scenario
+- **WHEN** some condition
+- **THEN** some outcome
 `;
         case 'design':
-            return `## Context
-
-<!-- Background and context -->
-
-## Goals / Non-Goals
-
-**Goals:**
-<!-- List goals -->
-
-**Non-Goals:**
-<!-- List non-goals -->
-
-## Decisions
-
-### 1. Decision Name
-
-Description and rationale.
-
-**Alternatives considered:**
-- Alternative 1: Rejected because...
-
-## Risks / Trade-offs
-
-<!-- List risks and trade-offs -->
+            return `## Context
+
+<!-- Background and context -->
+
+## Goals / Non-Goals
+
+**Goals:**
+<!-- List goals -->
+
+**Non-Goals:**
+<!-- List non-goals -->
+
+## Decisions
+
+### 1. Decision Name
+
+Description and rationale.
+
+**Alternatives considered:**
+- Alternative 1: Rejected because...
+
+## Risks / Trade-offs
+
+<!-- List risks and trade-offs -->
 `;
         case 'tasks':
-            return `## Implementation Tasks
-
-- [ ] Task 1
-- [ ] Task 2
-- [ ] Task 3
+            return `## Implementation Tasks
+
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
 `;
         default:
-            return `## ${artifactId}
-
-<!-- Add content here -->
+            return `## ${artifactId}
+
+<!-- Add content here -->
 `;
     }
 }

package/dist/core/command-generation/adapters/amazon-q.js

@@ -15,11 +15,11 @@ export const amazonQAdapter = {
         return path.join('.amazonq', 'prompts', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-description: ${content.description}
----
-
-${content.body}
+        return `---
+description: ${content.description}
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/antigravity.js

@@ -15,11 +15,11 @@ export const antigravityAdapter = {
         return path.join('.agent', 'workflows', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-description: ${content.description}
----
-
-${content.body}
+        return `---
+description: ${content.description}
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/auggie.js

@@ -15,12 +15,12 @@ export const auggieAdapter = {
         return path.join('.augment', 'commands', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-description: ${content.description}
-argument-hint: command arguments
----
-
-${content.body}
+        return `---
+description: ${content.description}
+argument-hint: command arguments
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/claude.js

@@ -36,14 +36,14 @@ export const claudeAdapter = {
         return path.join('.claude', 'commands', 'opsx', `${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-name: ${escapeYamlValue(content.name)}
-description: ${escapeYamlValue(content.description)}
-category: ${escapeYamlValue(content.category)}
-tags: ${formatTagsArray(content.tags)}
----
-
-${content.body}
+        return `---
+name: ${escapeYamlValue(content.name)}
+description: ${escapeYamlValue(content.description)}
+category: ${escapeYamlValue(content.category)}
+tags: ${formatTagsArray(content.tags)}
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/cline.js

@@ -16,11 +16,11 @@ export const clineAdapter = {
         return path.join('.clinerules', 'workflows', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `# ${content.name}
-
-${content.description}
-
-${content.body}
+        return `# ${content.name}
+
+${content.description}
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/codebuddy.js

@@ -15,13 +15,13 @@ export const codebuddyAdapter = {
         return path.join('.codebuddy', 'commands', 'opsx', `${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-name: ${content.name}
-description: "${content.description}"
-argument-hint: "[command arguments]"
----
-
-${content.body}
+        return `---
+name: ${content.name}
+description: "${content.description}"
+argument-hint: "[command arguments]"
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/codex.js

@@ -15,12 +15,12 @@ export const codexAdapter = {
         return path.join('.codex', 'prompts', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-description: ${content.description}
-argument-hint: command arguments
----
-
-${content.body}
+        return `---
+description: ${content.description}
+argument-hint: command arguments
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/continue.js

@@ -15,13 +15,13 @@ export const continueAdapter = {
         return path.join('.continue', 'prompts', `opsx-${commandId}.prompt`);
     },
     formatFile(content) {
-        return `---
-name: opsx-${content.id}
-description: ${content.description}
-invokable: true
----
-
-${content.body}
+        return `---
+name: opsx-${content.id}
+description: ${content.description}
+invokable: true
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/costrict.js

@@ -15,12 +15,12 @@ export const costrictAdapter = {
         return path.join('.cospec', 'openspec', 'commands', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-description: "${content.description}"
-argument-hint: command arguments
----
-
-${content.body}
+        return `---
+description: "${content.description}"
+argument-hint: command arguments
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/crush.js

@@ -16,14 +16,14 @@ export const crushAdapter = {
     },
     formatFile(content) {
         const tagsStr = content.tags.join(', ');
-        return `---
-name: ${content.name}
-description: ${content.description}
-category: ${content.category}
-tags: [${tagsStr}]
----
-
-${content.body}
+        return `---
+name: ${content.name}
+description: ${content.description}
+category: ${content.category}
+tags: [${tagsStr}]
+---
+
+${content.body}
 `;
     },
 };

package/dist/core/command-generation/adapters/cursor.js

@@ -30,14 +30,14 @@ export const cursorAdapter = {
         return path.join('.cursor', 'commands', `opsx-${commandId}.md`);
     },
     formatFile(content) {
-        return `---
-name: /opsx-${content.id}
-id: opsx-${content.id}
-category: ${escapeYamlValue(content.category)}
-description: ${escapeYamlValue(content.description)}
----
-
-${content.body}
+        return `---
+name: /opsx-${content.id}
+id: opsx-${content.id}
+category: ${escapeYamlValue(content.category)}
+description: ${escapeYamlValue(content.description)}
+---
+
+${content.body}
 `;
     },
 };