kiro-spec-engine 1.4.0 → 1.4.1

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 CHANGED
@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [1.4.1] - 2026-01-23
11
+
12
+ ### Fixed - Documentation Clarity 🎯
13
+
14
+ **Corrected Integration Flow**:
15
+ - **Fixed sequence diagrams** - Now correctly show "User ↔ AI Tool ↔ kse" instead of "User → kse → AI Tool"
16
+ - **Emphasized AI-driven workflow** - AI tools call kse directly, users stay in their familiar interface
17
+ - **Clarified positioning** - kse works behind the scenes, users don't "switch tools"
18
+
19
+ **Updated Documentation**:
20
+ - `README.md` - Rewrote Step 4 to emphasize AI tool calls kse automatically
21
+ - `README.zh.md` - Chinese version updated to match
22
+ - `docs/integration-modes.md` - Fixed sequence diagrams and workflow descriptions
23
+
24
+ **Key Message**:
25
+ - ✅ Users continue using their preferred AI tool (Cursor, Claude, Windsurf, etc.)
26
+ - ✅ AI tool calls kse commands during conversation
27
+ - ✅ No "tool switching" - seamless integration
28
+ - ✅ kse is the "context provider" working behind the scenes
29
+
30
+ ### Why This Matters
31
+
32
+ Users are already comfortable with their AI tools. kse enhances their existing workflow by providing structured context, not by replacing their tools. This patch clarifies that positioning.
33
+
10
34
  ## [1.4.0] - 2026-01-23
11
35
 
12
36
  ### Added - User Onboarding and Documentation Overhaul 📚
package/README.md CHANGED
@@ -116,31 +116,38 @@ This creates three files in `.kiro/specs/01-00-user-login/`:
116
116
  - [ ] 1.5 Write unit tests
117
117
  ```
118
118
 
119
- ### Step 4: Export Context for Your AI Tool (1 minute)
119
+ ### Step 4: Let Your AI Tool Use the Spec (1 minute)
120
120
 
121
- ```bash
122
- kse context export 01-00-user-login
123
- ```
121
+ Now your AI tool can access the Spec to generate better code.
124
122
 
125
- This generates `.kiro/specs/01-00-user-login/context-export.md` with all your Spec information formatted for AI tools.
123
+ **For AI tools with command execution (Cursor, Windsurf, Claude Desktop):**
126
124
 
127
- **Using with different AI tools:**
125
+ Just tell your AI:
126
+ ```
127
+ "I have a Spec at 01-00-user-login. Please implement task 1.1"
128
+ ```
128
129
 
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"
130
+ The AI will:
131
+ 1. Execute `kse context export 01-00-user-login`
132
+ 2. Read the Spec (requirements, design, tasks)
133
+ 3. Generate code that follows your design
134
+ 4. Update task status automatically
135
+
136
+ **For web-based AI tools (ChatGPT, Claude web):**
134
137
 
135
- **Cursor:**
136
138
  ```bash
137
- kse prompt generate 01-00-user-login 1.1
139
+ # Export context once
140
+ kse context export 01-00-user-login
141
+
142
+ # Copy to clipboard
143
+ cat .kiro/specs/01-00-user-login/context-export.md | pbcopy # macOS
144
+ type .kiro\specs\01-00-user-login\context-export.md | clip # Windows
145
+
146
+ # Paste into AI tool and say:
147
+ "Here's my Spec. Please implement task 1.1"
138
148
  ```
139
- Copy the generated prompt into Cursor Composer (Cmd+K)
140
149
 
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!)
150
+ **The key insight:** You stay in your AI tool. The AI reads the Spec and generates code that matches your design.
144
151
 
145
152
  ### Step 5: Next Steps (30 seconds)
146
153
 
@@ -88,27 +88,29 @@ Kiro AI:
88
88
  ## Mode 2: Manual Export
89
89
 
90
90
  **Best for:** Claude Code, ChatGPT, Cursor, VS Code + Copilot
91
- **Automation Level:** Semi-Manual
91
+ **Automation Level:** AI-Driven (for tools with command execution) or Semi-Manual (for web tools)
92
92
  **Setup Complexity:** Low
93
93
 
94
94
  ### How It Works
95
95
 
96
- You manually export context from kse and provide it to your AI tool. The AI tool doesn't directly access kse.
96
+ The AI tool can directly call kse commands during your conversation. You stay in your familiar AI tool interface - the AI handles kse interaction automatically.
97
97
 
98
98
  ```mermaid
99
99
  sequenceDiagram
100
100
  participant User
101
- participant kse
102
101
  participant AI Tool
102
+ participant kse
103
103
 
104
- User->>kse: kse context export spec-name
105
- kse->>User: context-export.md
106
- User->>User: Copy context
107
- User->>AI Tool: Paste context
108
- AI Tool->>User: Generate code
109
- User->>kse: Update tasks.md manually
104
+ User->>AI Tool: "Implement user login feature"
105
+ AI Tool->>kse: kse context export user-login
106
+ kse->>AI Tool: context-export.md content
107
+ AI Tool->>AI Tool: Generate code based on Spec
108
+ AI Tool->>User: Here's the implementation
109
+ AI Tool->>kse: Update tasks.md
110
110
  ```
111
111
 
112
+ **Note:** For AI tools without command execution (like ChatGPT web), you can manually export and paste as a fallback.
113
+
112
114
  ### Supported Tools
113
115
 
114
116
  - **Claude Code** - Large context window, excellent understanding
@@ -119,50 +121,52 @@ sequenceDiagram
119
121
 
120
122
  ### Workflow Example
121
123
 
122
- **Step 1: Export context**
123
- ```bash
124
- kse context export 01-00-user-login
125
- ```
126
-
127
- **Step 2: Copy context**
128
- ```bash
129
- # macOS
130
- cat .kiro/specs/01-00-user-login/context-export.md | pbcopy
131
-
132
- # Windows
133
- type .kiro\specs\01-00-user-login\context-export.md | clip
124
+ **With AI tools that can execute commands (Cursor, Windsurf, Claude Desktop):**
134
125
 
135
- # Linux
136
- cat .kiro/specs/01-00-user-login/context-export.md | xclip -selection clipboard
137
126
  ```
127
+ You: "I have a Spec for user login at 01-00-user-login.
128
+ Please implement task 1.1: Create AuthController"
138
129
 
139
- **Step 3: Paste into AI tool**
130
+ AI Tool:
131
+ [Executes: kse context export 01-00-user-login]
132
+ [Reads the exported context]
133
+ [Generates AuthController code]
134
+ [Updates tasks.md automatically]
135
+
136
+ ✓ Created AuthController with login/logout methods
137
+ ✓ Updated task 1.1 to complete
140
138
  ```
141
- [Paste context into Claude/ChatGPT/Cursor]
142
139
 
143
- You: "Please implement task 1.1: Create AuthController"
140
+ **With web-based AI tools (ChatGPT, Claude web):**
141
+
142
+ ```bash
143
+ # You run this once
144
+ kse context export 01-00-user-login
145
+ cat .kiro/specs/01-00-user-login/context-export.md | pbcopy
146
+
147
+ # Then paste into AI tool
148
+ You: "Here's my Spec context: [paste]
149
+ Please implement task 1.1: Create AuthController"
144
150
 
145
151
  AI: [Generates code based on your Spec]
146
- ```
147
152
 
148
- **Step 4: Update tasks**
149
- Edit `.kiro/specs/01-00-user-login/tasks.md`:
150
- ```markdown
151
- - [x] 1.1 Create AuthController ← Changed from [ ] to [x]
153
+ # You update tasks manually
154
+ # Edit .kiro/specs/01-00-user-login/tasks.md
152
155
  ```
153
156
 
154
157
  ### Advantages
155
158
 
156
159
  - ✅ **Works with any AI tool** - Universal compatibility
157
- - ✅ **Full control** - You decide what context to share
160
+ - ✅ **AI can call kse directly** - For tools with command execution
161
+ - ✅ **Fallback to manual** - Copy-paste for web-based tools
158
162
  - ✅ **Simple setup** - No configuration needed
159
- - ✅ **Reliable** - No dependencies on tool capabilities
163
+ - ✅ **Reliable** - No dependencies on special integrations
160
164
 
161
165
  ### Limitations
162
166
 
163
- - ❌ **Manual steps** - Copy-paste required
164
- - ❌ **Context can be stale** - Need to re-export after Spec changes
165
- - ❌ **Manual task tracking** - You update tasks.md yourself
167
+ - ❌ **Varies by tool** - Command execution depends on AI tool capabilities
168
+ - ❌ **Manual fallback** - Web-based tools require copy-paste
169
+ - ❌ **Context refresh** - May need to re-export after Spec changes (unless using Watch Mode)
166
170
 
167
171
  ### Optimization Tips
168
172
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kiro-spec-engine",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "Kiro Spec Engine - A spec-driven development engine with steering rules and quality enhancement powered by Ultrawork spirit",
5
5
  "main": "index.js",
6
6
  "bin": {