kiro-spec-engine 1.3.0 → 1.4.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.
Files changed (36) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/README.md +223 -369
  3. package/README.zh.md +0 -330
  4. package/docs/README.md +223 -0
  5. package/docs/command-reference.md +252 -0
  6. package/docs/examples/add-export-command/design.md +194 -0
  7. package/docs/examples/add-export-command/requirements.md +110 -0
  8. package/docs/examples/add-export-command/tasks.md +88 -0
  9. package/docs/examples/add-rest-api/design.md +855 -0
  10. package/docs/examples/add-rest-api/requirements.md +323 -0
  11. package/docs/examples/add-rest-api/tasks.md +355 -0
  12. package/docs/examples/add-user-dashboard/design.md +192 -0
  13. package/docs/examples/add-user-dashboard/requirements.md +143 -0
  14. package/docs/examples/add-user-dashboard/tasks.md +91 -0
  15. package/docs/faq.md +696 -0
  16. package/docs/integration-modes.md +525 -0
  17. package/docs/integration-philosophy.md +313 -0
  18. package/docs/quick-start-with-ai-tools.md +374 -0
  19. package/docs/quick-start.md +711 -0
  20. package/docs/spec-workflow.md +453 -0
  21. package/docs/tools/claude-guide.md +653 -0
  22. package/docs/tools/cursor-guide.md +705 -0
  23. package/docs/tools/generic-guide.md +445 -0
  24. package/docs/tools/kiro-guide.md +308 -0
  25. package/docs/tools/vscode-guide.md +444 -0
  26. package/docs/tools/windsurf-guide.md +390 -0
  27. package/docs/troubleshooting.md +795 -0
  28. package/docs/zh/README.md +275 -0
  29. package/docs/zh/quick-start.md +711 -0
  30. package/docs/zh/tools/claude-guide.md +348 -0
  31. package/docs/zh/tools/cursor-guide.md +280 -0
  32. package/docs/zh/tools/generic-guide.md +498 -0
  33. package/docs/zh/tools/kiro-guide.md +342 -0
  34. package/docs/zh/tools/vscode-guide.md +448 -0
  35. package/docs/zh/tools/windsurf-guide.md +377 -0
  36. package/package.json +1 -1
package/README.md CHANGED
@@ -1,470 +1,320 @@
1
- # kiro-spec-engine
1
+ # kse - Kiro Spec Engine
2
2
 
3
3
  [![npm version](https://badge.fury.io/js/kiro-spec-engine.svg)](https://badge.fury.io/js/kiro-spec-engine)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
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.
6
+ **A context provider for AI coding tools** - Structure your project requirements, design, and tasks so AI assistants can help you build better software.
9
7
 
10
8
  English | [简体中文](README.zh.md)
11
9
 
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
10
+ ---
25
11
 
26
- - **Spec-Driven Development**: Structured Requirements → Design → Tasks workflow
27
- - ✅ **Steering Rules System**: Control AI behavior with project-specific rules
28
- - ✅ **Multi-User Collaboration**: Personal workspaces, task claiming, team coordination
29
- - ✅ **Cross-Tool Compatibility**: Export context for Claude Code, Cursor, Codex, etc.
30
- - ✅ **Watch Mode Automation**: Automatic file monitoring and workflow execution
31
- - ✅ **Manual Workflows**: Step-by-step guides for common tasks
32
- - ✅ **Tool Detection**: Auto-detect IDE and suggest appropriate automation
33
- - ✅ **Quality Assessment**: Automatic document quality scoring (0-10 scale)
34
- - ✅ **Intelligent Enhancement**: Auto-identify and apply improvements with Ultrawork
35
- - ✅ **Professional Standards**: Ensure production-ready documentation
36
- - ✅ **Multi-language Support**: English and Chinese interfaces
37
- - ✅ **CLI Interface**: Easy-to-use command-line tools
12
+ ## What is kse?
38
13
 
39
- ## 🚀 Quick Start
14
+ **kse (Kiro Spec Engine) is a context management system for AI-assisted development.** It helps you organize project information into structured "Specs" (Requirements → Design → Tasks) that AI tools can understand and use effectively.
40
15
 
41
- ### Installation
16
+ Think of kse as a **librarian for your AI assistant** - it organizes and presents project context so your AI tool knows exactly what you're building, why, and how.
42
17
 
43
- Install globally via npm:
18
+ ### How it Works
44
19
 
45
- ```bash
46
- npm install -g kiro-spec-engine
20
+ ```mermaid
21
+ graph LR
22
+ A[You create Specs] --> B[kse organizes context]
23
+ B --> C[AI tool reads context]
24
+ C --> D[AI generates better code]
47
25
  ```
48
26
 
49
- Or use the short alias:
27
+ 1. **You create Specs** - Write requirements, design, and tasks in structured markdown files
28
+ 2. **kse organizes context** - Exports formatted context optimized for AI tools
29
+ 3. **AI tool reads context** - Your AI assistant understands your project structure
30
+ 4. **AI generates better code** - Code that matches your design and requirements
50
31
 
51
- ```bash
52
- npm install -g kiro-spec-engine
53
- # Creates both 'kiro-spec-engine' and 'kse' commands
54
- ```
32
+ ### What kse is NOT
55
33
 
56
- ### Initialize a Project
34
+ - **Not a code generator** - kse doesn't write code; your AI tool does
35
+ - ❌ **Not an IDE** - kse works alongside your existing development tools
36
+ - ❌ **Not AI-specific** - Works with Claude, Cursor, Windsurf, Copilot, and any AI tool
37
+ - ❌ **Not a replacement for documentation** - It's a structured way to organize project context
57
38
 
58
- ```bash
59
- # Initialize in current directory
60
- kiro-spec-engine init
39
+ ### Who Should Use kse?
61
40
 
62
- # Or specify project name
63
- kiro-spec-engine init "My Awesome Project"
41
+ - Developers using AI coding assistants (Claude, Cursor, Copilot, etc.)
42
+ - Teams wanting structured project documentation
43
+ - ✅ Anyone building features that need clear requirements and design
44
+ - ✅ Projects that benefit from spec-driven development
64
45
 
65
- # Use Chinese interface
66
- kiro-spec-engine --lang zh init
46
+ ---
67
47
 
68
- # Use short alias
69
- kse init
70
- ```
48
+ ## Quick Start (5 Minutes)
71
49
 
72
- ### Create and Enhance Your First Spec
50
+ ### Step 1: Install kse (30 seconds)
73
51
 
74
52
  ```bash
75
- # Create a new spec
76
- kse create-spec 01-00-user-authentication
77
-
78
- # Write your basic requirements.md file
79
- # Then enhance it with Ultrawork
80
- kse enhance requirements .kiro/specs/01-00-user-authentication/requirements.md
53
+ npm install -g kiro-spec-engine
81
54
  ```
82
55
 
83
- ## 📋 Commands
84
-
85
- ### Project Management
86
-
56
+ Verify installation:
87
57
  ```bash
88
- # Initialize project
89
- kse init [project-name]
90
-
91
- # Adopt existing project
92
- kse adopt # Interactive adoption
93
- kse adopt --auto # Skip confirmations
94
- kse adopt --dry-run # Show what would change
95
- kse adopt --mode fresh # Force specific mode
96
-
97
- # Upgrade project version
98
- kse upgrade # Interactive upgrade
99
- kse upgrade --auto # Skip confirmations
100
- kse upgrade --dry-run # Show upgrade plan
101
- kse upgrade --to 1.2.0 # Upgrade to specific version
102
-
103
- # Rollback to previous state
104
- kse rollback # Interactive rollback
105
- kse rollback --auto # Skip confirmations
106
- kse rollback --backup <id> # Restore specific backup
107
-
108
- # Check project status
109
- kse status
110
-
111
- # Create new spec
112
- kse create-spec <spec-name>
113
-
114
- # System diagnostics
115
- kse doctor
116
-
117
- # Set language
118
- kse --lang zh <command> # Chinese
119
- kse --lang en <command> # English (default)
58
+ kse --version
120
59
  ```
121
60
 
122
- ### Multi-User Collaboration
123
-
124
- ```bash
125
- # Initialize personal workspace
126
- kse workspace init
127
- kse workspace init --user=alice
128
-
129
- # Synchronize workspace with team
130
- kse workspace sync
61
+ ### Step 2: Adopt kse in Your Project (1 minute)
131
62
 
132
- # List all workspaces
133
- kse workspace list
134
-
135
- # Claim a task
136
- kse task claim <spec-name> <task-id>
137
- kse task claim 01-00-user-auth 1.1 --force
138
-
139
- # Unclaim a task
140
- kse task unclaim <spec-name> <task-id>
141
-
142
- # List claimed tasks
143
- kse task list <spec-name>
144
- ```
145
-
146
- ### Cross-Tool Support
63
+ Navigate to your project directory and run:
147
64
 
148
65
  ```bash
149
- # Export spec context for AI tools
150
- kse context export <spec-name>
151
- kse context export 01-00-user-auth --steering --steering-files=CORE_PRINCIPLES.md
152
-
153
- # Generate task-specific prompt
154
- kse prompt generate <spec-name> <task-id>
155
- kse prompt generate 01-00-user-auth 1.1 --tool=claude-code
156
- kse prompt generate 01-00-user-auth 1.2 --tool=cursor --max-length=5000
66
+ cd your-project
67
+ kse adopt
157
68
  ```
158
69
 
159
- ### Watch Mode (Automation)
70
+ This creates a `.kiro/` directory with:
71
+ - `specs/` - Where your Specs live
72
+ - `steering/` - Rules for AI behavior (optional)
73
+
74
+ ### Step 3: Create Your First Spec (2 minutes)
160
75
 
161
76
  ```bash
162
- # Initialize watch configuration
163
- kse watch init
164
- kse watch init --force # Overwrite existing config
165
-
166
- # Start watch mode
167
- kse watch start
168
- kse watch start --config custom-config.json
169
- kse watch start --patterns "**/*.md,**/*.js"
170
-
171
- # Stop watch mode
172
- kse watch stop
173
-
174
- # Check watch mode status
175
- kse watch status
176
-
177
- # View execution logs
178
- kse watch logs
179
- kse watch logs --tail 100
180
- kse watch logs --follow
181
-
182
- # View automation metrics
183
- kse watch metrics
184
- kse watch metrics --format json
185
-
186
- # List available presets
187
- kse watch presets
188
-
189
- # Install a preset
190
- kse watch install auto-sync
191
- kse watch install prompt-regen
192
- kse watch install context-export
193
- kse watch install test-runner
77
+ kse create-spec 01-00-user-login
194
78
  ```
195
79
 
196
- ### Manual Workflows
80
+ This creates three files in `.kiro/specs/01-00-user-login/`:
197
81
 
198
- ```bash
199
- # List available workflows
200
- kse workflows
82
+ **requirements.md** - What you're building:
83
+ ```markdown
84
+ # User Login Feature
201
85
 
202
- # Show workflow details
203
- kse workflows show task-sync
204
- kse workflows show context-export
205
- kse workflows show prompt-generation
86
+ ## User Stories
87
+ - As a user, I want to log in with email and password
88
+ - As a user, I want to see an error if credentials are wrong
206
89
 
207
- # Open full workflows guide
208
- kse workflows guide
209
-
210
- # Mark workflow as complete
211
- kse workflows complete task-sync
90
+ ## Acceptance Criteria
91
+ - WHEN user enters valid credentials THEN they are logged in
92
+ - WHEN user enters invalid credentials THEN they see an error message
212
93
  ```
213
94
 
214
- ### Document Enhancement
95
+ **design.md** - How you'll build it:
96
+ ```markdown
97
+ # Design
215
98
 
216
- ```bash
217
- # Enhance requirements document
218
- kse enhance requirements <file>
99
+ ## API Design
100
+ - POST /api/auth/login
101
+ - Request: { email: string, password: string }
102
+ - Response: { token: string } or { error: string }
219
103
 
220
- # Enhance design document (requires requirements file)
221
- kse enhance design <design-file> --requirements <requirements-file>
104
+ ## Components
105
+ - AuthController - handles login logic
106
+ - validateEmail() - validates email format
107
+ - validatePassword() - checks password requirements
108
+ ```
222
109
 
223
- # Check tasks completion
224
- kse enhance tasks <tasks-file>
110
+ **tasks.md** - Step-by-step implementation:
111
+ ```markdown
112
+ - [ ] 1.1 Create AuthController class
113
+ - [ ] 1.2 Implement email validation
114
+ - [ ] 1.3 Implement password validation
115
+ - [ ] 1.4 Implement login endpoint
116
+ - [ ] 1.5 Write unit tests
225
117
  ```
226
118
 
227
- ### Examples
119
+ ### Step 4: Export Context for Your AI Tool (1 minute)
228
120
 
229
121
  ```bash
230
- # Full workflow example
231
- kse init "E-commerce Platform"
232
- kse create-spec 01-00-user-auth
233
- # Edit .kiro/specs/01-00-user-auth/requirements.md
234
- kse enhance requirements .kiro/specs/01-00-user-auth/requirements.md
235
- # Edit .kiro/specs/01-00-user-auth/design.md
236
- kse enhance design .kiro/specs/01-00-user-auth/design.md --requirements .kiro/specs/01-00-user-auth/requirements.md
122
+ kse context export 01-00-user-login
237
123
  ```
238
124
 
239
- ## 📊 Quality Standards
240
-
241
- ### Requirements Stage (0-10 scoring)
242
- - **Basic Structure** (2pts): Overview, user stories, functional requirements, non-functional requirements
243
- - **EARS Format** (2pts): WHEN...THEN acceptance criteria
244
- - **User Stories** (2pts): "As a...I want...So that" format
245
- - **Acceptance Criteria** (2pts): Complete acceptance criteria definitions
246
- - **Non-functional Requirements** (1pt): Performance, security, usability, etc.
247
- - **Constraints** (1pt): Technical constraints, resource constraints, etc.
125
+ This generates `.kiro/specs/01-00-user-login/context-export.md` with all your Spec information formatted for AI tools.
248
126
 
249
- ### Design Stage (0-10 scoring)
250
- - **Basic Structure** (2pts): System overview, architecture design, component design, interface design
251
- - **Requirements Traceability** (2pts): Bidirectional traceability from requirements to design
252
- - **Architecture Diagrams** (1.5pts): Mermaid diagrams or other design diagrams
253
- - **Technology Selection** (1.5pts): Technology stack choices and rationale
254
- - **Non-functional Design** (1.5pts): Performance design, security design, scalability
255
- - **Interface Definition** (1.5pts): API design, data structure definitions
127
+ **Using with different AI tools:**
256
128
 
257
- ### Tasks Stage
258
- - **Completion Analysis**: Statistics on completed, in-progress, not-started tasks
259
- - **Priority Identification**: Identify priorities based on keywords and task numbers
260
- - **Ultrawork Motivation**: Provide Sisyphus spirit motivation and suggestions
261
- - **Next Steps Guidance**: Suggest specific execution strategies
129
+ **Claude Code / ChatGPT:**
130
+ 1. Open `context-export.md`
131
+ 2. Copy the entire content
132
+ 3. Paste into your AI conversation
133
+ 4. Say: "Please implement task 1.1"
262
134
 
263
- ## 🔄 Project Adoption and Upgrade
264
-
265
- ### Adopting Existing Projects
266
-
267
- KSE can intelligently adopt existing projects with three modes:
268
-
269
- **Fresh Adoption** (no `.kiro/` directory):
135
+ **Cursor:**
270
136
  ```bash
271
- kse adopt
272
- # Creates complete .kiro/ structure from scratch
137
+ kse prompt generate 01-00-user-login 1.1
273
138
  ```
139
+ Copy the generated prompt into Cursor Composer (Cmd+K)
274
140
 
275
- **Partial Adoption** (`.kiro/` exists but incomplete):
276
- ```bash
277
- kse adopt
278
- # Preserves existing specs/ and steering/
279
- # Adds missing components
280
- ```
141
+ **Windsurf / Cline:**
142
+ Just tell the AI: "Use kse to check the spec for user-login and implement task 1.1"
143
+ (These tools can execute kse commands directly!)
281
144
 
282
- **Full Adoption** (complete `.kiro/` from older version):
283
- ```bash
284
- kse adopt
285
- # Upgrades components to current version
286
- # Preserves all user content
287
- # Creates backup before changes
288
- ```
145
+ ### Step 5: Next Steps (30 seconds)
289
146
 
290
- ### Upgrading to New Versions
147
+ - 📖 Read the [Quick Start Guide](docs/quick-start.md) for detailed examples
148
+ - 🔧 Check your tool's integration guide: [Cursor](docs/tools/cursor-guide.md) | [Claude](docs/tools/claude-guide.md) | [Windsurf](docs/tools/windsurf-guide.md)
149
+ - 💡 Learn about [Integration Modes](docs/integration-modes.md)
291
150
 
292
- When a new version of KSE is released:
151
+ ---
293
152
 
294
- ```bash
295
- # Check current version
296
- kse --version
153
+ ## Core Concepts
297
154
 
298
- # Upgrade to latest version
299
- kse upgrade
155
+ ### Specs
300
156
 
301
- # Upgrade to specific version
302
- kse upgrade --to 1.2.0
157
+ A **Spec** is a structured description of a feature or project component. Each Spec contains:
303
158
 
304
- # Preview upgrade plan
305
- kse upgrade --dry-run
306
- ```
159
+ - **Requirements** (`requirements.md`) - What you're building and why
160
+ - **Design** (`design.md`) - How you'll build it (architecture, APIs, components)
161
+ - **Tasks** (`tasks.md`) - Step-by-step implementation checklist
307
162
 
308
- **Incremental Upgrades**: KSE automatically handles version gaps by upgrading through intermediate versions (e.g., 1.0.0 → 1.1.0 → 1.2.0).
163
+ ### Context Export
309
164
 
310
- ### Rollback and Safety
165
+ **Context export** transforms your Spec into a format optimized for AI tools. It includes:
166
+ - All requirements, design decisions, and tasks
167
+ - Project structure and conventions
168
+ - Steering rules (optional) for AI behavior
311
169
 
312
- All destructive operations create automatic backups:
170
+ ### Integration Modes
313
171
 
314
- ```bash
315
- # List available backups
316
- kse rollback
172
+ kse supports three ways to work with AI tools:
317
173
 
318
- # Restore from specific backup
319
- kse rollback --backup adopt-2026-01-23-100000
174
+ 1. **Native Integration** - AI tool directly accesses kse (Kiro IDE)
175
+ 2. **Manual Export** - You export and paste context (Claude, ChatGPT, Cursor)
176
+ 3. **Watch Mode** - Automatic context updates on file changes (all tools)
320
177
 
321
- # Quick rollback (interactive)
322
- kse rollback
323
- ```
178
+ Learn more: [Integration Modes Guide](docs/integration-modes.md)
324
179
 
325
- **Safety Features**:
326
- - ✅ Automatic backup before adoption/upgrade
327
- - ✅ Backup validation and integrity checking
328
- - ✅ Easy rollback to previous states
329
- - ✅ Dry-run mode to preview changes
330
-
331
- ## 🤖 Automation and Workflows
332
-
333
- ### Watch Mode
334
-
335
- Watch mode provides automatic file monitoring and workflow execution:
180
+ ---
336
181
 
337
- **Features**:
338
- - 📁 **File Monitoring**: Automatically detect file changes
339
- - ⚡ **Debouncing**: Prevent duplicate executions
340
- - 🔄 **Retry Logic**: Automatic retry with exponential backoff
341
- - 📊 **Metrics Tracking**: Track executions, time saved, success rates
342
- - 📝 **Execution Logging**: Complete audit trail with log rotation
182
+ ## Integration with Your AI Tool
343
183
 
344
- **Quick Start**:
345
- ```bash
346
- # Initialize watch configuration
347
- kse watch init
184
+ kse works with any AI coding assistant. Choose your tool for specific guidance:
348
185
 
349
- # Install a preset (auto-sync, prompt-regen, context-export, test-runner)
350
- kse watch install auto-sync
186
+ ### Popular AI Tools
351
187
 
352
- # Start watching
353
- kse watch start
188
+ - **[Cursor](docs/tools/cursor-guide.md)** - IDE with AI pair programming
189
+ - **[Claude Code](docs/tools/claude-guide.md)** - Anthropic's coding assistant
190
+ - **[Windsurf](docs/tools/windsurf-guide.md)** - AI agent with command execution
191
+ - **[Kiro](docs/tools/kiro-guide.md)** - Native integration, no manual export needed
192
+ - **[VS Code + Copilot](docs/tools/vscode-guide.md)** - GitHub Copilot integration
193
+ - **[Generic AI Tools](docs/tools/generic-guide.md)** - Works with any AI assistant
354
194
 
355
- # Check status
356
- kse watch status
195
+ ### Integration Workflow
357
196
 
358
- # View metrics
359
- kse watch metrics
197
+ ```mermaid
198
+ sequenceDiagram
199
+ participant You
200
+ participant kse
201
+ participant AI Tool
202
+ You->>kse: Create Spec (requirements, design, tasks)
203
+ You->>kse: Export context
204
+ kse->>You: context-export.md
205
+ You->>AI Tool: Provide context
206
+ AI Tool->>You: Generate code based on Spec
207
+ You->>kse: Update task status
360
208
  ```
361
209
 
362
- **Presets**:
363
- - `auto-sync`: Automatically sync workspace when tasks.md changes
364
- - `prompt-regen`: Regenerate prompts when requirements/design change
365
- - `context-export`: Export context when tasks complete
366
- - `test-runner`: Run tests when source files change
210
+ ---
367
211
 
368
- ### Tool Detection
212
+ ## Documentation
369
213
 
370
- KSE automatically detects your development environment and suggests appropriate automation:
214
+ ### Getting Started
215
+ - 📖 **[Quick Start Guide](docs/quick-start.md)** - Detailed 5-minute tutorial
216
+ - 🤔 **[FAQ](docs/faq.md)** - Frequently asked questions
217
+ - 🔧 **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions
371
218
 
372
- ```bash
373
- # During adoption, KSE detects:
374
- kse adopt
219
+ ### Core Guides
220
+ - 📋 **[Spec Workflow](docs/spec-workflow.md)** - Understanding Specs in depth
221
+ - 🔌 **[Integration Modes](docs/integration-modes.md)** - Three ways to integrate kse
222
+ - 📝 **[Command Reference](docs/command-reference.md)** - All kse commands
375
223
 
376
- # Detected: Kiro IDE → Suggests native agent hooks
377
- # Detected: VS Code/Cursor → Suggests watch mode
378
- # Detected: Other → Suggests manual workflows
379
- ```
224
+ ### Tool-Specific Guides
225
+ - [Cursor Integration](docs/tools/cursor-guide.md)
226
+ - [Claude Code Integration](docs/tools/claude-guide.md)
227
+ - [Windsurf Integration](docs/tools/windsurf-guide.md)
228
+ - [Kiro Integration](docs/tools/kiro-guide.md)
229
+ - [VS Code + Copilot Integration](docs/tools/vscode-guide.md)
230
+ - [Generic AI Tools](docs/tools/generic-guide.md)
380
231
 
381
- ### Manual Workflows
232
+ ### Examples
233
+ - [API Feature Example](docs/examples/add-rest-api/) - RESTful API Spec
234
+ - [UI Feature Example](docs/examples/add-user-dashboard/) - React dashboard Spec
235
+ - [CLI Feature Example](docs/examples/add-export-command/) - CLI command Spec
382
236
 
383
- For environments without automation, KSE provides step-by-step workflow guides:
237
+ ### Advanced Topics
238
+ - [Adoption Guide](docs/adoption-guide.md) - Adopting kse in existing projects
239
+ - [Upgrade Guide](docs/upgrade-guide.md) - Version upgrade instructions
240
+ - [Manual Workflows](docs/manual-workflows-guide.md) - Step-by-step workflows
241
+ - [Developer Guide](docs/developer-guide.md) - Contributing and extending kse
384
242
 
385
- ```bash
386
- # List available workflows
387
- kse workflows
243
+ ### Complete Documentation
244
+ - 📚 **[Documentation Index](docs/README.md)** - All documentation in one place
388
245
 
389
- # View workflow details
390
- kse workflows show task-sync # 30-60 seconds
391
- kse workflows show context-export # 15-45 seconds
392
- kse workflows show prompt-generation # 20-30 seconds
246
+ ---
393
247
 
394
- # Open complete guide
395
- kse workflows guide
396
- ```
248
+ ## Key Features
397
249
 
398
- **Available Workflows**:
399
- - **Task Sync**: Keep workspace synchronized with task progress
400
- - **Context Export**: Export spec context for AI assistants
401
- - **Prompt Generation**: Generate task-specific prompts
402
- - **Daily Checklist**: Complete daily workflow routine
403
- - **Task Completion**: Checklist for completing tasks
404
- - **Spec Creation**: Checklist for creating new specs
250
+ ### Spec-Driven Development
251
+ Structure your work with Requirements Design Tasks workflow
405
252
 
406
- ## 🛠️ Project Structure
253
+ ### Multi-User Collaboration
254
+ - Personal workspaces for team members
255
+ - Task claiming and tracking
256
+ - Workspace synchronization
407
257
 
408
- After initialization, your project will have:
258
+ ### Cross-Tool Compatibility
259
+ Export context for Claude Code, Cursor, Windsurf, Copilot, and more
409
260
 
410
- ```
411
- your-project/
412
- ├── .kiro/ # Kiro core directory
413
- │ ├── specs/ # Spec storage
414
- │ │ └── SPEC_WORKFLOW_GUIDE.md
415
- │ ├── steering/ # AI behavior rules (the "rules engine")
416
- │ │ ├── CORE_PRINCIPLES.md # Core principles + Ultrawork spirit
417
- │ │ ├── ENVIRONMENT.md # Environment configuration
418
- │ │ ├── CURRENT_CONTEXT.md # Current context
419
- │ │ └── RULES_GUIDE.md # Rules index
420
- │ ├── tools/ # Ultrawork tools
421
- │ │ └── ultrawork_enhancer.py # Core enhancement tool
422
- │ └── README.md # Kiro system documentation
423
- └── README.md # Project documentation
424
- ```
261
+ ### Watch Mode Automation
262
+ Automatic file monitoring and context updates
425
263
 
426
- ## 🔥 The Ultrawork Spirit
264
+ ### Quality Enhancement
265
+ - Document quality scoring (0-10 scale)
266
+ - Intelligent improvement suggestions
267
+ - Professional standards enforcement
427
268
 
428
- > 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.
269
+ ### Multi-Language Support
270
+ English and Chinese interfaces
429
271
 
430
- The Ultrawork spirit embodies:
272
+ ---
431
273
 
432
- - **Relentless Effort**: Never give up when facing challenges
433
- - **Continuous Improvement**: Always strive for better quality
434
- - **Professional Standards**: Pursue excellence in every detail (9.0/10 target)
435
- - **Persistent Execution**: Keep pushing forward until completion
274
+ ## Command Overview
436
275
 
437
- Ultrawork is the **quality enhancement philosophy** within Kiro Spec Engine—it's what drives the engine to produce professional-grade results.
276
+ ```bash
277
+ # Project setup
278
+ kse adopt # Adopt kse in existing project
279
+ kse create-spec <name> # Create new Spec
438
280
 
439
- ## 🌍 Multi-language Support
281
+ # Context management
282
+ kse context export <spec-name> # Export context for AI tools
283
+ kse prompt generate <spec> <task> # Generate task-specific prompt
440
284
 
441
- Kiro Spec Engine supports multiple languages out of the box.
285
+ # Task management
286
+ kse task claim <spec> <task-id> # Claim a task
287
+ kse task list <spec> # List claimed tasks
442
288
 
443
- ### Setting Language
289
+ # Automation
290
+ kse watch start # Start watch mode
291
+ kse watch status # Check watch status
444
292
 
445
- ```bash
446
- # Using command line option
447
- kse --lang zh init
293
+ # Project info
294
+ kse status # Project status
295
+ kse workflows # List available workflows
296
+ ```
448
297
 
449
- # Using environment variable
450
- export KIRO_LANG=zh
451
- kse init
298
+ See [Command Reference](docs/command-reference.md) for complete documentation.
452
299
 
453
- # Windows
454
- set KIRO_LANG=zh
455
- kse init
456
- ```
300
+ ---
457
301
 
458
- ### Supported Languages
302
+ ## Contributing & Support
459
303
 
460
- - 🇺🇸 English (en) - Default
461
- - 🇨🇳 Simplified Chinese (zh)
304
+ ### Getting Help
462
305
 
463
- 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.
306
+ - 📖 **Documentation**: Start with the [Quick Start Guide](docs/quick-start.md)
307
+ - 🐛 **Bug Reports**: [GitHub Issues](https://github.com/yourusername/kiro-spec-engine/issues)
308
+ - 💬 **Discussions**: [GitHub Discussions](https://github.com/yourusername/kiro-spec-engine/discussions)
309
+ - 📧 **Email**: support@example.com
464
310
 
465
- ## 🤝 Contributing
311
+ ### Contributing
466
312
 
467
- We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
313
+ We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for:
314
+ - Code contributions
315
+ - Documentation improvements
316
+ - Bug reports and feature requests
317
+ - Translation help
468
318
 
469
319
  ### Development Setup
470
320
 
@@ -473,20 +323,18 @@ git clone https://github.com/yourusername/kiro-spec-engine.git
473
323
  cd kiro-spec-engine
474
324
  npm install
475
325
  npm link # For local development
326
+ npm test # Run tests
476
327
  ```
477
328
 
478
- ### Adding New Languages
479
-
480
- 1. Create a new language file in `locales/` (e.g., `ja.json`)
481
- 2. Copy the structure from `en.json` and translate all text
482
- 3. Add language detection logic in `lib/i18n.js`
483
- 4. Update README documentation
329
+ ---
484
330
 
485
- ## 📄 License
331
+ ## License
486
332
 
487
333
  MIT License - see [LICENSE](LICENSE) file for details.
488
334
 
489
- ## 🙏 Acknowledgments
335
+ ---
336
+
337
+ ## Acknowledgments
490
338
 
491
339
  - Inspired by the **Sisyphus** myth and the concept of noble struggle
492
340
  - Built on the foundation of **Kiro** spec-driven development
@@ -494,9 +342,15 @@ MIT License - see [LICENSE](LICENSE) file for details.
494
342
 
495
343
  ---
496
344
 
497
- **Start your spec-driven journey today! 🔥**
345
+ **Ready to enhance your AI-assisted development?** 🚀
498
346
 
499
347
  ```bash
500
348
  npm install -g kiro-spec-engine
501
- kse init
349
+ kse adopt
350
+ kse create-spec 01-00-my-first-feature
502
351
  ```
352
+
353
+ ---
354
+
355
+ **Version**: 1.4.0
356
+ **Last Updated**: 2026-01-23