npm - @clawplays/ospec-cli - Versions diffs - 0.3.0 → 0.3.2 - Mend

@clawplays/ospec-cli 0.3.0 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-<h1><a href="https://ospec.ai/" target="_blank" rel="noopener noreferrer">OSpec</a></h1>
+<h1><a href="https://ospec.ai/" target="_blank" rel="noopener noreferrer">OSpec.ai</a></h1>
 <p align="center">
   <a href="https://www.npmjs.com/package/@clawplays/ospec-cli"><img src="https://img.shields.io/npm/v/%40clawplays%2Fospec-cli?style=for-the-badge&logo=npm&label=npm" alt="npm"></a>
@@ -16,14 +16,14 @@
 <p align="center">
   <strong>English</strong> |
-  <a href="README.zh-CN.md">中文</a> |
-  <a href="README.ja.md">日本語</a>
+  <a href="docs/README.zh-CN.md">中文</a> |
+  <a href="docs/README.ja.md">日本語</a> |
+  <a href="docs/README.ar.md">العربية</a>
 </p>
 OSpec is a document-driven workflow for AI-assisted development, helping you define requirements and changes in docs first, then drive implementation, validation, and archive through AI collaboration.
 <p align="center">
-  <a href="docs/README.md">Docs</a> |
   <a href="docs/prompt-guide.md">Prompt Guide</a> |
   <a href="docs/usage.md">Usage</a> |
   <a href="docs/project-overview.md">Overview</a> |
@@ -264,7 +264,6 @@ Notes:
 ### Core Docs
-- [Docs Index](docs/README.md)
 - [Prompt Guide](docs/prompt-guide.md)
 - [Usage](docs/usage.md)
 - [Project Overview](docs/project-overview.md)

package/dist/cli.js CHANGED Viewed

@@ -224,7 +224,7 @@ const services_1 = require("./services");
-const CLI_VERSION = '0.3.0';
+const CLI_VERSION = '0.3.2';
 function showInitUsage() {
     console.log('Usage: ospec init [root-dir] [--summary "..."] [--tech-stack node,react] [--architecture "..."] [--document-language zh-CN|en-US]');

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@clawplays/ospec-cli",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "CLI tool for enforcing ospec workflow",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/README.ja.md DELETED Viewed

@@ -1,290 +0,0 @@
-<h1><a href="https://ospec.ai/" target="_blank" rel="noopener noreferrer">OSpec</a></h1>
-<p align="center">
-  <a href="https://www.npmjs.com/package/@clawplays/ospec-cli"><img src="https://img.shields.io/npm/v/%40clawplays%2Fospec-cli?style=for-the-badge&logo=npm&label=npm" alt="npm"></a>
-  <a href="https://www.npmjs.com/package/@clawplays/ospec-cli"><img src="https://img.shields.io/npm/dm/%40clawplays%2Fospec-cli?style=for-the-badge&logo=npm&label=downloads&cacheSeconds=300" alt="npm downloads"></a>
-  <a href="https://github.com/clawplays/ospec/stargazers"><img src="https://img.shields.io/github/stars/clawplays/ospec?style=for-the-badge&logo=github" alt="GitHub stars"></a>
-  <a href="LICENSE"><img src="https://img.shields.io/github/license/clawplays/ospec?style=for-the-badge&color=green" alt="License"></a>
-</p>
-<p align="center">
-  <img src="https://img.shields.io/badge/Node.js-18%2B-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js 18+">
-  <img src="https://img.shields.io/badge/npm-8%2B-CB3837?style=flat-square&logo=npm&logoColor=white" alt="npm 8+">
-  <img src="https://img.shields.io/badge/language-TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript">
-  <img src="https://img.shields.io/badge/workflow-3_steps-0F766E?style=flat-square" alt="3-step workflow">
-</p>
-<p align="center">
-  <a href="README.md">English</a> |
-  <a href="README.zh-CN.md">中文</a> |
-  <strong>日本語</strong>
-</p>
-OSpec は AI 対話コラボレーション向けのドキュメント駆動開発ワークフローです。最初にドキュメントで要件と変更を明確にし、その後 AI との協調で実装、検証、アーカイブを進めます。
-<p align="center">
-  <a href="docs/README.ja.md">ドキュメント</a> |
-  <a href="docs/prompt-guide.ja.md">プロンプトガイド</a> |
-  <a href="docs/usage.md">使い方</a> |
-  <a href="docs/project-overview.md">概要</a> |
-  <a href="docs/installation.md">インストール</a> |
-  <a href="https://github.com/clawplays/ospec/issues">Issues</a>
-</p>
-## npm でインストール
-```bash
-npm install -g @clawplays/ospec-cli
-```
-## 推奨プロンプト
-OSpec の利用は、ほとんどの場合この 3 ステップで十分です。
-1. プロジェクトディレクトリで OSpec を初期化する
-2. 要件、ドキュメント更新、バグ修正のための change を作成して進める
-3. 受け入れ完了後にその change をアーカイブする
-### 1. プロジェクトディレクトリで初期化する
-推奨プロンプト:
-```text
-OSpec を使ってこのプロジェクトを初期化してください。
-```
-Claude / Codex skill:
-```text
-$ospec を使ってこのプロジェクトを初期化してください。
-```
-<details>
-<summary>コマンドライン</summary>
-```bash
-ospec init .
-ospec init . --summary "Internal admin portal for operations"
-ospec init . --summary "Internal admin portal for operations" --tech-stack node,react,postgres
-ospec init . --architecture "Single web app with API and shared auth" --document-language ja-JP
-```
-メモ:
-- `--summary`: 生成ドキュメントに書き込むプロジェクト概要
-- `--tech-stack`: `node,react,postgres` のようなカンマ区切りの技術スタック
-- `--architecture`: 短いアーキテクチャ説明
-- `--document-language`: 生成ドキュメントの言語。通常は `en-US`、`zh-CN`、`ja-JP`
-- 値を渡した場合はその内容を使ってドキュメントを生成します
-- 値を渡さない場合は既存ドキュメントを優先利用し、無ければ補完用のプレースホルダを生成します
-</details>
-### 2. Change を作成して進める
-要件実装、ドキュメント更新、リファクタ、バグ修正はこの流れを使います。
-推奨プロンプト:
-```text
-OSpec を使ってこの要件の change を作成して進めてください。
-```
-Claude / Codex skill:
-```text
-$ospec-change を使ってこの要件の change を作成して進めてください。
-```
-![OSpec Change slash command example](docs/assets/ospecchange-slash-command.ja.svg)
-<details>
-<summary>コマンドライン</summary>
-```bash
-ospec new docs-homepage-refresh .
-ospec new fix-login-timeout .
-ospec new update-billing-copy .
-```
-</details>
-### 3. 受け入れ完了後にアーカイブする
-デプロイ、テスト、QA、またはその他の受け入れ確認が終わった後に、確認済みの change をアーカイブします。
-推奨プロンプト:
-```text
-OSpec を使って承認済みの change をアーカイブしてください。
-```
-Claude / Codex skill:
-```text
-$ospec を使って承認済みの change をアーカイブしてください。
-```
-<details>
-<summary>コマンドライン</summary>
-```bash
-ospec verify changes/active/<change-name>
-ospec finalize changes/active/<change-name>
-```
-メモ:
-- 先にプロジェクト固有のデプロイ、テスト、QA を実行します
-- `ospec verify` で change がアーカイブ可能か確認します
-- `ospec finalize` でインデックスを再構築し、change をアーカイブします
-</details>
-## OSpec の動作イメージ
-```text
-┌─────────────────────────────────────────────────────────────────┐
-│  1. USER REQUEST                                               │
-│     "Use OSpec to create and advance a change for this task."  │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  2. INIT TO CHANGE-READY                                       │
-│     ospec init                                                 │
-│     - .skillrc                                                 │
-│     - .ospec/                                                  │
-│     - changes/active + changes/archived                        │
-│     - root SKILL files and for-ai guidance                     │
-│     - docs/project/* baseline knowledge docs                   │
-│     - reuse docs or fall back to placeholders                  │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  3. EXECUTION                                                  │
-│     ospec new <change-name>                                    │
-│     ospec progress                                             │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  4. DEPLOY + VALIDATE                                          │
-│     project deploy / test / QA                                 │
-│     ospec verify                                               │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  5. ARCHIVE                                                    │
-│     ospec finalize                                             │
-│     rebuild index + archive                                    │
-└─────────────────────────────────────────────────────────────────┘
-```
-## 3 つの主要概念
-| 概念 | 説明 |
-|------|------|
-| **Protocol Shell** | `.skillrc`、`.ospec/`、`changes/`、ルートの `SKILL.md`、`SKILL.index.json`、`for-ai/` を含む最小の協調骨格 |
-| **Project Knowledge Layer** | `docs/project/*`、レイヤード skill ファイル、index 状態など AI が継続的に参照するコンテキスト |
-| **Active Change** | 1 つの要件専用の実行コンテナ。通常 `proposal.md`、`tasks.md`、`state.json`、`verification.md`、`review.md` を持つ |
-## 主な機能
-- **change-ready 初期化**: `ospec init` が protocol shell と基礎ドキュメントを一度に生成
-- **ガイド付き初期化**: AI 支援時は不足している概要や技術スタックを 1 回だけ確認可能
-- **ドキュメント保守**: `ospec docs generate` で後から知識レイヤを更新・修復
-- **change 実行の追跡**: proposal、tasks、state、verification、review を継続的に揃える
-- **キュー支援**: `queue` と `run` で複数 change の明示的な実行を管理
-- **プラグインゲート**: Stitch のデザインレビューと Checkpoint の自動化チェックをサポート
-- **標準クローズアウト**: `finalize` が検証、インデックス再構築、アーカイブを行う
-## プラグイン機能
-OSpec には、文書駆動ワークフローに UI レビューとフロー検証を追加する 2 つのオプションプラグインがあります。
-### Stitch
-Stitch はページデザインレビューとプレビュー共有に使います。ランディングページや UI 変更が多い change に向いています。
-AI 対話:
-```text
-OSpec を使って Stitch プラグインを有効にしてください。
-```
-Claude / Codex skill:
-```text
-$ospec を使って Stitch プラグインを有効にしてください。
-```
-<details>
-<summary>コマンドライン</summary>
-```bash
-ospec plugins enable stitch .
-```
-</details>
-### Checkpoint
-Checkpoint は画面フロー検証と自動チェックに使います。重要フローや受け入れ前のランタイム検証に向いています。
-AI 対話:
-```text
-OSpec を使って Checkpoint プラグインを有効にしてください。
-```
-Claude / Codex skill:
-```text
-$ospec を使って Checkpoint プラグインを有効にしてください。
-```
-<details>
-<summary>コマンドライン</summary>
-```bash
-ospec plugins enable checkpoint . --base-url http://127.0.0.1:3000
-```
-メモ:
-- `--base-url` は自動チェック対象となる起動中アプリの URL を指定します
-</details>
-## ドキュメント
-### コアドキュメント
-- [Docs Index](docs/README.ja.md)
-- [Prompt Guide](docs/prompt-guide.ja.md)
-- [Usage](docs/usage.md)
-- [Project Overview](docs/project-overview.md)
-- [Installation](docs/installation.md)
-- [Skills Installation](docs/skills-installation.md)
-### プラグイン仕様
-- [Stitch Plugin Spec](docs/stitch-plugin-spec.zh-CN.md)
-- [Checkpoint Plugin Spec](docs/checkpoint-plugin-spec.zh-CN.md)
-## リポジトリ構成
-```text
-dist/                       コンパイル済み CLI ランタイム
-assets/                     管理対象プロトコル資産、hooks、skill payload
-docs/                       公開ドキュメント
-scripts/                    リリースとインストール補助スクリプト
-.ospec/templates/hooks/     パッケージ同梱の Git hook テンプレート
-```
-## License
-This project is licensed under the [MIT License](LICENSE).

package/README.zh-CN.md DELETED Viewed

@@ -1,291 +0,0 @@
-<h1><a href="https://ospec.ai/" target="_blank" rel="noopener noreferrer">OSpec</a></h1>
-<p align="center">
-  <a href="https://www.npmjs.com/package/@clawplays/ospec-cli"><img src="https://img.shields.io/npm/v/%40clawplays%2Fospec-cli?style=for-the-badge&logo=npm&label=npm" alt="npm"></a>
-  <a href="https://www.npmjs.com/package/@clawplays/ospec-cli"><img src="https://img.shields.io/npm/dm/%40clawplays%2Fospec-cli?style=for-the-badge&logo=npm&label=downloads&cacheSeconds=300" alt="npm downloads"></a>
-  <a href="https://github.com/clawplays/ospec/stargazers"><img src="https://img.shields.io/github/stars/clawplays/ospec?style=for-the-badge&logo=github" alt="GitHub stars"></a>
-  <a href="LICENSE"><img src="https://img.shields.io/github/license/clawplays/ospec?style=for-the-badge&color=green" alt="License"></a>
-</p>
-<p align="center">
-  <img src="https://img.shields.io/badge/Node.js-18%2B-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js 18+">
-  <img src="https://img.shields.io/badge/npm-8%2B-CB3837?style=flat-square&logo=npm&logoColor=white" alt="npm 8+">
-  <img src="https://img.shields.io/badge/language-TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript">
-  <img src="https://img.shields.io/badge/workflow-3_steps-0F766E?style=flat-square" alt="3-step workflow">
-</p>
-<p align="center">
-  <a href="README.md">English</a> |
-  <strong>中文</strong> |
-  <a href="README.ja.md">日本語</a>
-</p>
-OSpec 是一个面向 AI 对话协作的文档驱动开发工作流，让你先用文档明确需求与变更，再驱动 AI 实现、验证与归档。
-<p align="center">
-  <a href="docs/README.zh-CN.md">文档入口</a> |
-  <a href="docs/prompt-guide.zh-CN.md">提示词文档</a> |
-  <a href="docs/usage.zh-CN.md">使用说明</a> |
-  <a href="docs/project-overview.zh-CN.md">项目介绍</a> |
-  <a href="docs/installation.zh-CN.md">安装说明</a> |
-  <a href="https://github.com/clawplays/ospec/issues">Issues</a>
-</p>
-## npm 安装
-```bash
-npm install -g @clawplays/ospec-cli
-```
-## 推荐提示词
-大多数团队使用 OSpec，只要 3 步：
-1. 在你的项目目录初始化项目
-2. 为文档更新、需求开发或 Bug 修复创建并推进一个 change
-3. 在需求验收通过后归档这个 change
-### 1. 在你的项目目录初始化项目
-推荐提示词：
-```text
-使用 OSpec 初始化这个项目。
-```
-Claude / Codex Skill 方式：
-```text
-使用 $ospec 初始化这个项目。
-```
-<details>
-<summary>命令行</summary>
-```bash
-ospec init .
-ospec init . --summary "运营后台"
-ospec init . --summary "运营后台" --tech-stack node,react,postgres
-ospec init . --architecture "单体 Web 应用 + API + 统一鉴权" --document-language zh-CN
-```
-命令行说明：
-- `--summary`：项目概况，会写入生成的项目文档
-- `--tech-stack`：技术栈，使用逗号分隔，例如 `node,react,postgres`
-- `--architecture`：简短的架构说明
-- `--document-language`：生成文档的语言，通常使用 `zh-CN` 或 `en-US`
-- 传了这些参数，就按你提供的内容生成项目说明
-- 不传时，OSpec 会优先复用现有文档；如果没有，就先生成待补充的默认文档
-</details>
-### 2. 创建并推进一个 Change
-文档更新、需求开发、重构、Bug 修复，都使用这一类方式。
-推荐提示词：
-```text
-使用 OSpec 为这个需求创建并推进一个 change。
-```
-Claude / Codex Skill 方式：
-```text
-使用 $ospec-change 为这个需求创建并推进一个 change。
-```
-![OSpec Change Slash Command 示例](docs/assets/ospecchange-slash-command.zh-CN.svg)
-<details>
-<summary>命令行</summary>
-```bash
-ospec new docs-homepage-refresh .
-ospec new fix-login-timeout .
-ospec new update-billing-copy .
-```
-</details>
-### 3. 验收通过后归档
-当需求已经完成部署、测试、QA 或业务验收后，再归档这个 change。
-推荐提示词：
-```text
-使用 OSpec 归档这个已验收通过的 change。
-```
-Claude / Codex Skill 方式：
-```text
-使用 $ospec 归档这个已验收通过的 change。
-```
-<details>
-<summary>命令行</summary>
-```bash
-ospec verify changes/active/<change-name>
-ospec finalize changes/active/<change-name>
-```
-归档说明：
-- 先完成你项目自己的部署、测试、QA 或验收流程
-- 使用 `ospec verify` 确认当前 change 已满足归档条件
-- 使用 `ospec finalize` 重建索引并归档这个已验收通过的 change
-</details>
-## OSpec 的工作方式
-```text
-┌─────────────────────────────────────────────────────────────────┐
-│  1. 用户提出需求                                                │
-│     “使用 OSpec 为这个任务创建并推进一个 change。”             │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  2. 初始化到 change-ready                                       │
-│     ospec init                                                  │
-│     - .skillrc                                                  │
-│     - .ospec/                                                   │
-│     - changes/active + changes/archived                         │
-│     - 根目录 SKILL 文件和 for-ai 规则文档                       │
-│     - docs/project/* 基础知识文档                               │
-│     - 复用已有文档或回退到占位文档                              │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  3. 执行                                                        │
-│     ospec new <change-name>                                     │
-│     ospec progress                                              │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  4. 部署并验证                                                  │
-│     项目部署 / 测试 / QA                                        │
-│     ospec verify                                                │
-└─────────────────────────────────────────────────────────────────┘
-                              │
-                              ▼
-┌─────────────────────────────────────────────────────────────────┐
-│  5. 归档                                                        │
-│     ospec finalize                                              │
-│     重建索引 + archive                                           │
-└─────────────────────────────────────────────────────────────────┘
-```
-## 三个核心概念
-| 概念 | 说明 |
-|------|------|
-| **协议壳** | 最小协作骨架，包括 `.skillrc`、`.ospec/`、`changes/`、根目录 `SKILL.md`、`SKILL.index.json` 和 `for-ai/` 规则文档。 |
-| **项目知识层** | 给 AI 持续读取的项目上下文，例如 `docs/project/*`、分层技能文件和索引状态。 |
-| **Active Change** | 单个需求的独立执行容器，通常包含 `proposal.md`、`tasks.md`、`state.json`、`verification.md`、`review.md`。 |
-## 功能特性
-- **一步到 change-ready 的初始化**：`ospec init` 一次性创建协议壳和基础项目知识文档。
-- **带追问能力的初始化**：在 AI 协作初始化中，如果缺少项目概况或技术栈，可以只追问一次；纯 CLI 初始化则直接落占位文档。
-- **知识层维护命令**：`ospec docs generate` 用于后续刷新、修复或补齐项目知识层。
-- **需求执行可追踪**：一个 change 可以持续对齐 proposal、tasks、state、verification、review。
-- **显式队列能力**：`queue` 和 `run` 用于多 change 场景，不会默认偷偷进入队列模式。
-- **插件工作流门禁**：内置支持 Stitch 设计审核和 Checkpoint 自动化检查。
-- **skills 管理**：支持 Codex 和 Claude Code 的 OSpec skill 安装与检查。
-- **标准收口路径**：`finalize` 负责验证、重建索引和归档，Git 提交仍保持手动可控。
-## 插件功能
-OSpec 内置两个可选插件，用来把 UI 审核和流程验证接入到文档驱动交付流程中。
-### Stitch
-用于页面设计审核与预览协作，适合落地页、营销页和 UI 变化较多的需求。
-AI 对话方式：
-```text
-使用 OSpec 帮我打开 Stitch 插件。
-```
-Claude / Codex Skill 方式：
-```text
-使用 $ospec 帮我打开 Stitch 插件。
-```
-<details>
-<summary>命令行</summary>
-```bash
-ospec plugins enable stitch .
-```
-</details>
-### Checkpoint
-用于应用流程验证与自动化检查，适合提交流程、关键路径和验收前的运行验证。
-AI 对话方式：
-```text
-使用 OSpec 帮我打开 Checkpoint 插件。
-```
-Claude / Codex Skill 方式：
-```text
-使用 $ospec 帮我打开 Checkpoint 插件。
-```
-<details>
-<summary>命令行</summary>
-```bash
-ospec plugins enable checkpoint . --base-url http://127.0.0.1:3000
-```
-说明：
-- `--base-url` 用来指定运行中的应用地址，供自动化检查使用
-</details>
-## 文档入口
-### 核心文档
-- [文档总览](docs/README.zh-CN.md)
-- [提示词文档](docs/prompt-guide.zh-CN.md)
-- [使用说明](docs/usage.zh-CN.md)
-- [项目介绍](docs/project-overview.zh-CN.md)
-- [安装说明](docs/installation.zh-CN.md)
-- [Skills 安装说明](docs/skills-installation.zh-CN.md)
-### 插件高级说明
-- [Stitch 插件规范](docs/stitch-plugin-spec.zh-CN.md)
-- [Checkpoint 插件规范](docs/checkpoint-plugin-spec.zh-CN.md)
-## 仓库结构
-```text
-dist/                       编译后的 CLI 运行时
-assets/                     托管协议资产、hooks 和 skill 载荷
-docs/                       对外文档
-scripts/                    发布和安装辅助脚本
-.ospec/templates/hooks/     随包分发的 Git hook 模板
-```
-## License
-本项目使用 [MIT License](LICENSE)。