kiro-spec-engine 1.0.0

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.
package/CHANGELOG.md ADDED
@@ -0,0 +1,60 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Added
11
+ - Initial project structure
12
+ - CLI implementation with Node.js
13
+ - Ultrawork quality enhancement tool (Python)
14
+ - Multi-language support (English and Chinese)
15
+ - Project initialization command (`kse init`)
16
+ - Spec creation command (`kse create-spec`)
17
+ - Status checking command (`kse status`)
18
+ - Document enhancement command (`kse enhance`)
19
+
20
+ ### Documentation
21
+ - README.md (English)
22
+ - README.zh.md (Chinese)
23
+ - CONTRIBUTING.md
24
+ - LICENSE (MIT)
25
+
26
+ ## [1.0.0] - 2026-01-23
27
+
28
+ ### Added
29
+ - Initial stable release
30
+ - Complete npm and GitHub release pipeline
31
+ - Python dependency detection with OS-specific installation instructions
32
+ - Doctor command for system diagnostics
33
+ - Automated CI/CD with GitHub Actions
34
+ - Multi-language support (English and Chinese)
35
+ - Comprehensive test infrastructure
36
+ - Ultrawork quality enhancement tool
37
+ - CLI commands: init, doctor, --version, --help
38
+ - Template system for new projects
39
+
40
+ ### Documentation
41
+ - Complete README with installation and usage guide
42
+ - Chinese README (README.zh.md)
43
+ - Contributing guidelines (CONTRIBUTING.md)
44
+ - MIT License
45
+
46
+ ### Infrastructure
47
+ - GitHub Actions workflows for testing and releasing
48
+ - Jest test framework with property-based testing support
49
+ - Cross-platform support (Windows, macOS, Linux)
50
+ - Node.js 16+ support
51
+
52
+ ---
53
+
54
+ **Legend**:
55
+ - `Added` for new features
56
+ - `Changed` for changes in existing functionality
57
+ - `Deprecated` for soon-to-be removed features
58
+ - `Removed` for now removed features
59
+ - `Fixed` for any bug fixes
60
+ - `Security` for vulnerability fixes
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Kiro Ultrawork
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,242 @@
1
+ # kiro-spec-engine
2
+
3
+ [![npm version](https://badge.fury.io/js/kiro-spec-engine.svg)](https://badge.fury.io/js/kiro-spec-engine)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ **Kiro Spec Engine** - A spec-driven rules engine with quality enhancement powered by Ultrawork spirit.
7
+
8
+ > 🔥 Transform your development workflow with structured specs, steering rules, and relentless quality pursuit.
9
+
10
+ English | [简体中文](README.zh.md)
11
+
12
+ ## 🎯 What is Kiro Spec Engine?
13
+
14
+ Kiro Spec Engine (KSE) is a **spec-driven rules engine** that brings structure, quality, and the **Ultrawork spirit** to your development process. It's not just a tool—it's a methodology for building software with clarity and excellence.
15
+
16
+ ### Core Concept: Spec-Driven Rules Engine
17
+
18
+ At its heart, KSE is a **rules engine** that operates on **specs**:
19
+
20
+ - **Specs** define what you want to build (Requirements → Design → Tasks)
21
+ - **Steering rules** guide how AI assistants should help you build it
22
+ - **Ultrawork spirit** ensures professional-grade quality at every stage
23
+
24
+ ### Key Features
25
+
26
+ - ✅ **Spec-Driven Development**: Structured Requirements → Design → Tasks workflow
27
+ - ✅ **Steering Rules System**: Control AI behavior with project-specific rules
28
+ - ✅ **Quality Assessment**: Automatic document quality scoring (0-10 scale)
29
+ - ✅ **Intelligent Enhancement**: Auto-identify and apply improvements with Ultrawork
30
+ - ✅ **Professional Standards**: Ensure production-ready documentation
31
+ - ✅ **Multi-language Support**: English and Chinese interfaces
32
+ - ✅ **CLI Interface**: Easy-to-use command-line tools
33
+
34
+ ## 🚀 Quick Start
35
+
36
+ ### Installation
37
+
38
+ Install globally via npm:
39
+
40
+ ```bash
41
+ npm install -g kiro-spec-engine
42
+ ```
43
+
44
+ Or use the short alias:
45
+
46
+ ```bash
47
+ npm install -g kiro-spec-engine
48
+ # Creates both 'kiro-spec-engine' and 'kse' commands
49
+ ```
50
+
51
+ ### Initialize a Project
52
+
53
+ ```bash
54
+ # Initialize in current directory
55
+ kiro-spec-engine init
56
+
57
+ # Or specify project name
58
+ kiro-spec-engine init "My Awesome Project"
59
+
60
+ # Use Chinese interface
61
+ kiro-spec-engine --lang zh init
62
+
63
+ # Use short alias
64
+ kse init
65
+ ```
66
+
67
+ ### Create and Enhance Your First Spec
68
+
69
+ ```bash
70
+ # Create a new spec
71
+ kse create-spec 01-00-user-authentication
72
+
73
+ # Write your basic requirements.md file
74
+ # Then enhance it with Ultrawork
75
+ kse enhance requirements .kiro/specs/01-00-user-authentication/requirements.md
76
+ ```
77
+
78
+ ## 📋 Commands
79
+
80
+ ### Project Management
81
+
82
+ ```bash
83
+ # Initialize project
84
+ kse init [project-name]
85
+
86
+ # Check project status
87
+ kse status
88
+
89
+ # Create new spec
90
+ kse create-spec <spec-name>
91
+
92
+ # Set language
93
+ kse --lang zh <command> # Chinese
94
+ kse --lang en <command> # English (default)
95
+ ```
96
+
97
+ ### Document Enhancement
98
+
99
+ ```bash
100
+ # Enhance requirements document
101
+ kse enhance requirements <file>
102
+
103
+ # Enhance design document (requires requirements file)
104
+ kse enhance design <design-file> --requirements <requirements-file>
105
+
106
+ # Check tasks completion
107
+ kse enhance tasks <tasks-file>
108
+ ```
109
+
110
+ ### Examples
111
+
112
+ ```bash
113
+ # Full workflow example
114
+ kse init "E-commerce Platform"
115
+ kse create-spec 01-00-user-auth
116
+ # Edit .kiro/specs/01-00-user-auth/requirements.md
117
+ kse enhance requirements .kiro/specs/01-00-user-auth/requirements.md
118
+ # Edit .kiro/specs/01-00-user-auth/design.md
119
+ kse enhance design .kiro/specs/01-00-user-auth/design.md --requirements .kiro/specs/01-00-user-auth/requirements.md
120
+ ```
121
+
122
+ ## 📊 Quality Standards
123
+
124
+ ### Requirements Stage (0-10 scoring)
125
+ - **Basic Structure** (2pts): Overview, user stories, functional requirements, non-functional requirements
126
+ - **EARS Format** (2pts): WHEN...THEN acceptance criteria
127
+ - **User Stories** (2pts): "As a...I want...So that" format
128
+ - **Acceptance Criteria** (2pts): Complete acceptance criteria definitions
129
+ - **Non-functional Requirements** (1pt): Performance, security, usability, etc.
130
+ - **Constraints** (1pt): Technical constraints, resource constraints, etc.
131
+
132
+ ### Design Stage (0-10 scoring)
133
+ - **Basic Structure** (2pts): System overview, architecture design, component design, interface design
134
+ - **Requirements Traceability** (2pts): Bidirectional traceability from requirements to design
135
+ - **Architecture Diagrams** (1.5pts): Mermaid diagrams or other design diagrams
136
+ - **Technology Selection** (1.5pts): Technology stack choices and rationale
137
+ - **Non-functional Design** (1.5pts): Performance design, security design, scalability
138
+ - **Interface Definition** (1.5pts): API design, data structure definitions
139
+
140
+ ### Tasks Stage
141
+ - **Completion Analysis**: Statistics on completed, in-progress, not-started tasks
142
+ - **Priority Identification**: Identify priorities based on keywords and task numbers
143
+ - **Ultrawork Motivation**: Provide Sisyphus spirit motivation and suggestions
144
+ - **Next Steps Guidance**: Suggest specific execution strategies
145
+
146
+ ## 🛠️ Project Structure
147
+
148
+ After initialization, your project will have:
149
+
150
+ ```
151
+ your-project/
152
+ ├── .kiro/ # Kiro core directory
153
+ │ ├── specs/ # Spec storage
154
+ │ │ └── SPEC_WORKFLOW_GUIDE.md
155
+ │ ├── steering/ # AI behavior rules (the "rules engine")
156
+ │ │ ├── CORE_PRINCIPLES.md # Core principles + Ultrawork spirit
157
+ │ │ ├── ENVIRONMENT.md # Environment configuration
158
+ │ │ ├── CURRENT_CONTEXT.md # Current context
159
+ │ │ └── RULES_GUIDE.md # Rules index
160
+ │ ├── tools/ # Ultrawork tools
161
+ │ │ └── ultrawork_enhancer.py # Core enhancement tool
162
+ │ └── README.md # Kiro system documentation
163
+ └── README.md # Project documentation
164
+ ```
165
+
166
+ ## 🔥 The Ultrawork Spirit
167
+
168
+ > Inspired by Sisyphus from Greek mythology, who was condemned to push a boulder up a mountain for eternity, only to watch it roll back down each time.
169
+
170
+ The Ultrawork spirit embodies:
171
+
172
+ - **Relentless Effort**: Never give up when facing challenges
173
+ - **Continuous Improvement**: Always strive for better quality
174
+ - **Professional Standards**: Pursue excellence in every detail (9.0/10 target)
175
+ - **Persistent Execution**: Keep pushing forward until completion
176
+
177
+ Ultrawork is the **quality enhancement philosophy** within Kiro Spec Engine—it's what drives the engine to produce professional-grade results.
178
+
179
+ ## 🌍 Multi-language Support
180
+
181
+ Kiro Spec Engine supports multiple languages out of the box.
182
+
183
+ ### Setting Language
184
+
185
+ ```bash
186
+ # Using command line option
187
+ kse --lang zh init
188
+
189
+ # Using environment variable
190
+ export KIRO_LANG=zh
191
+ kse init
192
+
193
+ # Windows
194
+ set KIRO_LANG=zh
195
+ kse init
196
+ ```
197
+
198
+ ### Supported Languages
199
+
200
+ - 🇺🇸 English (en) - Default
201
+ - 🇨🇳 Simplified Chinese (zh)
202
+
203
+ The tool automatically detects your system language and uses it by default. You can override this with the `--lang` option or `KIRO_LANG` environment variable.
204
+
205
+ ## 🤝 Contributing
206
+
207
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
208
+
209
+ ### Development Setup
210
+
211
+ ```bash
212
+ git clone https://github.com/yourusername/kiro-spec-engine.git
213
+ cd kiro-spec-engine
214
+ npm install
215
+ npm link # For local development
216
+ ```
217
+
218
+ ### Adding New Languages
219
+
220
+ 1. Create a new language file in `locales/` (e.g., `ja.json`)
221
+ 2. Copy the structure from `en.json` and translate all text
222
+ 3. Add language detection logic in `lib/i18n.js`
223
+ 4. Update README documentation
224
+
225
+ ## 📄 License
226
+
227
+ MIT License - see [LICENSE](LICENSE) file for details.
228
+
229
+ ## 🙏 Acknowledgments
230
+
231
+ - Inspired by the **Sisyphus** myth and the concept of noble struggle
232
+ - Built on the foundation of **Kiro** spec-driven development
233
+ - Influenced by **oh-my-opencode** and the Ultrawork Manifesto
234
+
235
+ ---
236
+
237
+ **Start your spec-driven journey today! 🔥**
238
+
239
+ ```bash
240
+ npm install -g kiro-spec-engine
241
+ kse init
242
+ ```
package/README.zh.md ADDED
@@ -0,0 +1,242 @@
1
+ # kiro-spec-engine
2
+
3
+ [![npm version](https://badge.fury.io/js/kiro-spec-engine.svg)](https://badge.fury.io/js/kiro-spec-engine)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ **Kiro Spec Engine** - 基于 Spec 的驱动规则引擎,融入 Ultrawork 精神的质量增强工具。
7
+
8
+ > 🔥 用结构化的 Spec、Steering 规则和不懈的质量追求,改变你的开发工作流。
9
+
10
+ [English](README.md) | 简体中文
11
+
12
+ ## 🎯 什么是 Kiro Spec Engine?
13
+
14
+ Kiro Spec Engine (KSE) 是一个 **基于 Spec 的驱动规则引擎**,为你的开发过程带来结构、质量和 **Ultrawork 精神**。它不仅仅是一个工具——更是一种以清晰和卓越构建软件的方法论。
15
+
16
+ ### 核心概念:Spec 驱动规则引擎
17
+
18
+ KSE 的核心是一个基于 **Specs** 运作的**规则引擎**:
19
+
20
+ - **Specs** 定义你要构建什么(Requirements → Design → Tasks)
21
+ - **Steering 规则** 指导 AI 助手如何帮助你构建
22
+ - **Ultrawork 精神** 确保每个阶段的专业级质量
23
+
24
+ ### 核心特性
25
+
26
+ - ✅ **Spec 驱动开发**: 结构化的 Requirements → Design → Tasks 工作流
27
+ - ✅ **Steering 规则系统**: 用项目特定规则控制 AI 行为
28
+ - ✅ **质量评估**: 自动文档质量评分(0-10 分制)
29
+ - ✅ **智能增强**: 通过 Ultrawork 自动识别和应用改进
30
+ - ✅ **专业标准**: 确保生产就绪的文档
31
+ - ✅ **多语言支持**: 支持中文和英文界面
32
+ - ✅ **CLI 接口**: 易用的命令行工具
33
+
34
+ ## 🚀 快速开始
35
+
36
+ ### 安装
37
+
38
+ 通过 npm 全局安装:
39
+
40
+ ```bash
41
+ npm install -g kiro-spec-engine
42
+ ```
43
+
44
+ 或使用短别名:
45
+
46
+ ```bash
47
+ npm install -g kiro-spec-engine
48
+ # 创建 'kiro-spec-engine' 和 'kse' 两个命令
49
+ ```
50
+
51
+ ### 初始化项目
52
+
53
+ ```bash
54
+ # 在当前目录初始化
55
+ kiro-spec-engine init
56
+
57
+ # 或指定项目名称
58
+ kiro-spec-engine init "我的超棒项目"
59
+
60
+ # 使用中文界面
61
+ kiro-spec-engine --lang zh init
62
+
63
+ # 使用短别名
64
+ kse init
65
+ ```
66
+
67
+ ### 创建并增强你的第一个 Spec
68
+
69
+ ```bash
70
+ # 创建新 Spec
71
+ kse create-spec 01-00-user-authentication
72
+
73
+ # 编写基础 requirements.md 文件
74
+ # 然后使用 Ultrawork 增强
75
+ kse enhance requirements .kiro/specs/01-00-user-authentication/requirements.md
76
+ ```
77
+
78
+ ## 📋 命令
79
+
80
+ ### 项目管理
81
+
82
+ ```bash
83
+ # 初始化项目
84
+ kse init [项目名称]
85
+
86
+ # 检查项目状态
87
+ kse status
88
+
89
+ # 创建新 Spec
90
+ kse create-spec <spec-名称>
91
+
92
+ # 设置语言
93
+ kse --lang zh <命令> # 中文
94
+ kse --lang en <命令> # 英文
95
+ ```
96
+
97
+ ### 文档增强
98
+
99
+ ```bash
100
+ # 增强需求文档
101
+ kse enhance requirements <文件>
102
+
103
+ # 增强设计文档(需要需求文件)
104
+ kse enhance design <设计文件> --requirements <需求文件>
105
+
106
+ # 检查任务完成情况
107
+ kse enhance tasks <任务文件>
108
+ ```
109
+
110
+ ### 示例
111
+
112
+ ```bash
113
+ # 完整工作流示例
114
+ kse init "电商平台"
115
+ kse create-spec 01-00-user-auth
116
+ # 编辑 .kiro/specs/01-00-user-auth/requirements.md
117
+ kse enhance requirements .kiro/specs/01-00-user-auth/requirements.md
118
+ # 编辑 .kiro/specs/01-00-user-auth/design.md
119
+ kse enhance design .kiro/specs/01-00-user-auth/design.md --requirements .kiro/specs/01-00-user-auth/requirements.md
120
+ ```
121
+
122
+ ## 📊 质量标准
123
+
124
+ ### Requirements 阶段(0-10 评分)
125
+ - **基础结构**(2分):概述、用户故事、功能需求、非功能需求
126
+ - **EARS 格式**(2分):WHEN...THEN 验收标准
127
+ - **用户故事**(2分):"作为...我希望...以便" 格式
128
+ - **验收标准**(2分):完整的验收标准定义
129
+ - **非功能需求**(1分):性能、安全、可用性等
130
+ - **约束条件**(1分):技术约束、资源约束等
131
+
132
+ ### Design 阶段(0-10 评分)
133
+ - **基础结构**(2分):系统概述、架构设计、组件设计、接口设计
134
+ - **需求追溯**(2分):需求到设计的双向追溯
135
+ - **架构图**(1.5分):Mermaid 图或其他设计图
136
+ - **技术选型**(1.5分):技术栈选择和理由
137
+ - **非功能设计**(1.5分):性能设计、安全设计、可扩展性
138
+ - **接口定义**(1.5分):API 设计、数据结构定义
139
+
140
+ ### Tasks 阶段
141
+ - **完成率分析**:统计已完成、进行中、未开始任务
142
+ - **优先级识别**:基于关键词和任务编号识别优先级
143
+ - **Ultrawork 激励**:提供 Sisyphus 精神激励和建议
144
+ - **下一步指导**:建议具体的执行策略
145
+
146
+ ## 🛠️ 项目结构
147
+
148
+ 初始化后,你的项目将包含:
149
+
150
+ ```
151
+ your-project/
152
+ ├── .kiro/ # Kiro 核心目录
153
+ │ ├── specs/ # Spec 存储
154
+ │ │ └── SPEC_WORKFLOW_GUIDE.md
155
+ │ ├── steering/ # AI 行为规则("规则引擎")
156
+ │ │ ├── CORE_PRINCIPLES.md # 核心原则 + Ultrawork 精神
157
+ │ │ ├── ENVIRONMENT.md # 环境配置
158
+ │ │ ├── CURRENT_CONTEXT.md # 当前上下文
159
+ │ │ └── RULES_GUIDE.md # 规则索引
160
+ │ ├── tools/ # Ultrawork 工具
161
+ │ │ └── ultrawork_enhancer.py # 核心增强工具
162
+ │ └── README.md # Kiro 系统文档
163
+ └── README.md # 项目文档
164
+ ```
165
+
166
+ ## 🔥 Ultrawork 精神
167
+
168
+ > 受希腊神话中西西弗斯的启发,他被判永远推石上山,每次快到山顶时石头就会滚下来。
169
+
170
+ Ultrawork 精神体现:
171
+
172
+ - **不懈努力**:面对挑战永不放弃
173
+ - **持续改进**:始终追求更好的质量
174
+ - **专业标准**:在每个细节上追求卓越(9.0/10 目标)
175
+ - **坚持执行**:持续推进直到完成
176
+
177
+ Ultrawork 是 Kiro Spec Engine 中的**质量增强哲学**——它驱动引擎产出专业级结果。
178
+
179
+ ## 🌍 多语言支持
180
+
181
+ Kiro Spec Engine 支持多种语言:
182
+
183
+ ### 设置语言
184
+
185
+ ```bash
186
+ # 使用命令行参数
187
+ kse --lang zh init
188
+
189
+ # 使用环境变量
190
+ export KIRO_LANG=zh
191
+ kse init
192
+
193
+ # Windows
194
+ set KIRO_LANG=zh
195
+ kse init
196
+ ```
197
+
198
+ ### 支持的语言
199
+
200
+ - 🇺🇸 English (en) - 默认
201
+ - 🇨🇳 简体中文 (zh)
202
+
203
+ 工具会自动检测你的系统语言并默认使用。你可以通过 `--lang` 选项或 `KIRO_LANG` 环境变量覆盖默认设置。
204
+
205
+ ## 🤝 贡献
206
+
207
+ 我们欢迎贡献!请查看我们的[贡献指南](CONTRIBUTING.md)了解详情。
208
+
209
+ ### 开发设置
210
+
211
+ ```bash
212
+ git clone https://github.com/yourusername/kiro-spec-engine.git
213
+ cd kiro-spec-engine
214
+ npm install
215
+ npm link # 用于本地开发
216
+ ```
217
+
218
+ ### 添加新语言
219
+
220
+ 1. 在 `locales/` 目录创建新的语言文件(如 `ja.json`)
221
+ 2. 复制 `en.json` 的结构并翻译所有文本
222
+ 3. 在 `lib/i18n.js` 中添加语言检测逻辑
223
+ 4. 更新 README 文档
224
+
225
+ ## 📄 许可证
226
+
227
+ MIT License - 详见 [LICENSE](LICENSE) 文件。
228
+
229
+ ## 🙏 致谢
230
+
231
+ - 受 **Sisyphus** 神话和高贵奋斗概念的启发
232
+ - 基于 **Kiro** Spec 驱动开发的基础
233
+ - 受 **oh-my-opencode** 和 Ultrawork Manifesto 的影响
234
+
235
+ ---
236
+
237
+ **今天就开始你的 Spec 驱动之旅!🔥**
238
+
239
+ ```bash
240
+ npm install -g kiro-spec-engine
241
+ kse --lang zh init
242
+ ```