scene-capability-engine 3.0.1 → 3.0.3
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 +235 -233
- package/LICENSE +2 -2
- package/README.md +8 -11
- package/README.zh.md +7 -10
- package/bin/kse.js +1 -1
- package/bin/sce.js +1 -1
- package/bin/sco.js +1 -1
- package/docs/331-poc-adaptation-roadmap.md +25 -25
- package/docs/331-poc-dual-track-integration-guide.md +26 -26
- package/docs/331-poc-weekly-delivery-checklist.md +8 -8
- package/docs/OFFLINE_INSTALL.md +10 -10
- package/docs/README.md +24 -24
- package/docs/adopt-migration-guide.md +51 -51
- package/docs/adoption-guide.md +56 -56
- package/docs/agent-hooks-analysis.md +52 -52
- package/docs/architecture.md +6 -6
- package/docs/articles/ai-driven-development-philosophy-and-practice-review.md +4 -4
- package/docs/articles/ai-driven-development-philosophy-and-practice.en.md +9 -9
- package/docs/articles/ai-driven-development-philosophy-and-practice.md +10 -10
- package/docs/autonomous-control-guide.md +89 -89
- package/docs/command-reference.md +31 -16
- package/docs/community.md +4 -4
- package/docs/cross-tool-guide.md +47 -47
- package/docs/developer-guide.md +5 -5
- package/docs/document-governance.md +91 -91
- package/docs/environment-management-guide.md +53 -53
- package/docs/examples/add-export-command/design.md +2 -2
- package/docs/examples/add-export-command/requirements.md +5 -5
- package/docs/examples/add-export-command/tasks.md +2 -2
- package/docs/faq.md +69 -69
- package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.json +9 -9
- package/docs/handoffs/evidence/ontology/moqui-template-baseline-2026-02-17-232922.md +3 -3
- package/docs/images/wechat-qr.png +0 -0
- package/docs/integration-modes.md +60 -60
- package/docs/integration-philosophy.md +48 -48
- package/docs/knowledge-management-guide.md +21 -21
- package/docs/manual-workflows-guide.md +20 -20
- package/docs/moqui-capability-matrix.md +43 -22
- package/docs/moqui-template-core-library-playbook.md +49 -21
- package/docs/multi-agent-coordination-guide.md +19 -19
- package/docs/multi-repo-management-guide.md +93 -93
- package/docs/quick-start-with-ai-tools.md +36 -36
- package/docs/quick-start.md +16 -16
- package/docs/release-checklist.md +7 -7
- package/docs/releases/v1.46.2-validation.md +1 -1
- package/docs/releases/v1.46.2.md +10 -10
- package/docs/scene-runtime-guide.md +42 -42
- package/docs/spec-collaboration-guide.md +43 -43
- package/docs/spec-locking-guide.md +26 -26
- package/docs/spec-numbering-guide.md +6 -6
- package/docs/spec-workflow.md +25 -25
- package/docs/steering-strategy-guide.md +36 -36
- package/docs/team-collaboration-guide.md +23 -23
- package/docs/testing-strategy.md +2 -2
- package/docs/tools/claude-guide.md +26 -26
- package/docs/tools/cursor-guide.md +31 -31
- package/docs/tools/generic-guide.md +22 -22
- package/docs/tools/kiro-guide.md +43 -43
- package/docs/tools/vscode-guide.md +18 -18
- package/docs/tools/windsurf-guide.md +50 -50
- package/docs/troubleshooting.md +116 -116
- package/docs/upgrade-guide.md +49 -49
- package/docs/value-observability-guide.md +6 -6
- package/docs/zh/README.md +22 -22
- package/docs/zh/quick-start.md +34 -34
- package/docs/zh/release-checklist.md +6 -6
- package/docs/zh/releases/v1.46.2-validation.md +1 -1
- package/docs/zh/releases/v1.46.2.md +9 -9
- package/docs/zh/spec-numbering-guide.md +6 -6
- package/docs/zh/tools/claude-guide.md +14 -14
- package/docs/zh/tools/cursor-guide.md +18 -18
- package/docs/zh/tools/generic-guide.md +40 -40
- package/docs/zh/tools/kiro-guide.md +50 -50
- package/docs/zh/tools/vscode-guide.md +20 -20
- package/docs/zh/tools/windsurf-guide.md +49 -49
- package/docs/zh/value-observability-guide.md +6 -6
- package/docs//344/272/244/344/273/230/346/270/205/345/215/225.md +4 -4
- package/lib/adoption/adoption-logger.js +1 -1
- package/lib/adoption/adoption-strategy.js +3 -3
- package/lib/adoption/detection-engine.js +1 -1
- package/lib/adoption/error-formatter.js +17 -17
- package/lib/adoption/progress-reporter.js +2 -2
- package/lib/adoption/smart-orchestrator.js +2 -2
- package/lib/adoption/strategy-selector.js +2 -2
- package/lib/adoption/summary-generator.js +3 -3
- package/lib/auto/autonomous-engine.js +2 -2
- package/lib/auto/close-loop-runner.js +9 -9
- package/lib/backup/backup-system.js +2 -2
- package/lib/collab/collab-manager.js +2 -2
- package/lib/commands/adopt.js +16 -16
- package/lib/commands/auto.js +1148 -106
- package/lib/commands/collab.js +8 -8
- package/lib/commands/docs.js +26 -26
- package/lib/commands/doctor.js +2 -2
- package/lib/commands/env.js +14 -14
- package/lib/commands/knowledge.js +13 -13
- package/lib/commands/lock.js +6 -6
- package/lib/commands/ops.js +19 -19
- package/lib/commands/orchestrate.js +5 -5
- package/lib/commands/prompt.js +3 -3
- package/lib/commands/rollback.js +4 -4
- package/lib/commands/scene.js +30 -30
- package/lib/commands/spec-bootstrap.js +1 -1
- package/lib/commands/spec-gate.js +1 -1
- package/lib/commands/spec-pipeline.js +1 -1
- package/lib/commands/task.js +1 -1
- package/lib/commands/templates.js +27 -27
- package/lib/commands/upgrade.js +8 -8
- package/lib/commands/value.js +4 -4
- package/lib/commands/watch.js +9 -9
- package/lib/commands/workflows.js +5 -5
- package/lib/commands/workspace-multi.js +17 -17
- package/lib/commands/workspace.js +5 -5
- package/lib/context/context-exporter.js +1 -1
- package/lib/context/prompt-generator.js +1 -1
- package/lib/data/moqui-capability-lexicon.json +258 -2
- package/lib/environment/environment-manager.js +1 -1
- package/lib/gitignore/gitignore-detector.js +4 -4
- package/lib/gitignore/gitignore-integration.js +2 -2
- package/lib/gitignore/gitignore-transformer.js +3 -3
- package/lib/gitignore/layered-rules-template.js +2 -2
- package/lib/governance/diagnostic-engine.js +4 -4
- package/lib/governance/doc-reference-checker.js +1 -1
- package/lib/governance/hooks-manager.js +5 -5
- package/lib/governance/reporter.js +1 -1
- package/lib/knowledge/knowledge-manager.js +6 -6
- package/lib/orchestrator/agent-spawner.js +1 -1
- package/lib/orchestrator/bootstrap-prompt-builder.js +2 -2
- package/lib/orchestrator/orchestration-engine.js +55 -6
- package/lib/repo/config-manager.js +2 -2
- package/lib/repo/handlers/init-handler.js +3 -3
- package/lib/scene-runtime/audit-emitter.js +2 -2
- package/lib/scene-runtime/binding-plugin-loader.js +1 -1
- package/lib/scene-runtime/moqui-adapter.js +2 -2
- package/lib/scene-runtime/moqui-extractor.js +3 -3
- package/lib/scene-runtime/scene-loader.js +3 -3
- package/lib/scene-runtime/scene-template-linter.js +1 -1
- package/lib/scene-runtime/templates/scene-template-erp-query-v0.1.yaml +1 -1
- package/lib/scene-runtime/templates/scene-template-hybrid-shadow-v0.1.yaml +1 -1
- package/lib/spec/multi-spec-orchestrate.js +1 -1
- package/lib/spec-gate/rules/default-rules.js +1 -1
- package/lib/steering/adoption-config.js +1 -1
- package/lib/steering/compliance-auto-fixer.js +1 -1
- package/lib/steering/compliance-cache.js +3 -3
- package/lib/steering/compliance-error-reporter.js +1 -1
- package/lib/steering/index.js +1 -1
- package/lib/steering/steering-manager.js +7 -7
- package/lib/task/task-claimer.js +2 -1
- package/lib/templates/metadata-collector.js +6 -6
- package/lib/templates/template-creator.js +2 -2
- package/lib/templates/template-exporter.js +12 -12
- package/lib/upgrade/migration-engine.js +4 -4
- package/lib/utils/tool-detector.js +25 -25
- package/lib/utils/validation.js +3 -3
- package/lib/version/version-checker.js +13 -13
- package/lib/version/version-manager.js +7 -7
- package/lib/watch/presets.js +4 -4
- package/lib/workspace/multi/path-utils.js +1 -1
- package/lib/workspace/multi/workspace-context-resolver.js +9 -9
- package/lib/workspace/multi/workspace-registry.js +2 -2
- package/lib/workspace/multi/workspace-state-manager.js +1 -1
- package/lib/workspace/multi/workspace.js +1 -1
- package/lib/workspace/workspace-sync.js +1 -1
- package/locales/en.json +1 -1
- package/locales/zh.json +1 -1
- package/package.json +3 -5
- package/template/.kiro/README.md +40 -40
- package/template/.kiro/specs/SPEC_WORKFLOW_GUIDE.md +3 -3
- package/template/.kiro/steering/CORE_PRINCIPLES.md +3 -3
- package/template/.kiro/steering/ENVIRONMENT.md +2 -2
- package/template/README.md +3 -3
- /package/bin/{kiro-spec-engine.js → scene-capability-engine.js} +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
The Spec-level collaboration system enables multiple AI instances (
|
|
5
|
+
The Spec-level collaboration system enables multiple AI instances (SCE) to work on different Specs in parallel within a large project. This guide explains how to use the collaboration features to coordinate parallel development efforts.
|
|
6
6
|
|
|
7
7
|
## Key Concepts
|
|
8
8
|
|
|
@@ -23,9 +23,9 @@ Specs can depend on other Specs in three ways:
|
|
|
23
23
|
|
|
24
24
|
Interface contracts formally define the APIs, data structures, and behaviors that a Spec provides or consumes. They ensure compatibility between independently developed Specs.
|
|
25
25
|
|
|
26
|
-
###
|
|
26
|
+
### SCE Instances
|
|
27
27
|
|
|
28
|
-
A
|
|
28
|
+
A SCE instance is an AI assistant working on a specific Spec. You can assign Specs to different instances to enable parallel development.
|
|
29
29
|
|
|
30
30
|
## Quick Start
|
|
31
31
|
|
|
@@ -34,7 +34,7 @@ A Kiro instance is an AI assistant working on a specific Spec. You can assign Sp
|
|
|
34
34
|
Create a Master Spec with Sub-Specs:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
|
|
37
|
+
sce collab init user-management \
|
|
38
38
|
--sub-specs user-service auth-service session-manager \
|
|
39
39
|
--dependencies "auth-service:user-service" \
|
|
40
40
|
--dependencies "session-manager:auth-service"
|
|
@@ -50,23 +50,23 @@ This creates:
|
|
|
50
50
|
View all Specs and their status:
|
|
51
51
|
|
|
52
52
|
```bash
|
|
53
|
-
|
|
53
|
+
sce collab status
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
View dependency graph:
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
|
-
|
|
59
|
+
sce collab status --graph
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
### 3. Assign Specs to
|
|
62
|
+
### 3. Assign Specs to SCE Instances
|
|
63
63
|
|
|
64
64
|
Assign Specs to different AI instances:
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
67
|
+
sce collab assign user-service SCE-1
|
|
68
|
+
sce collab assign auth-service SCE-2
|
|
69
|
+
sce collab assign session-manager SCE-3
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
### 4. Define Interface Contracts
|
|
@@ -115,7 +115,7 @@ Create an interface contract for a Spec (in `.kiro/specs/{spec-name}/interfaces/
|
|
|
115
115
|
Verify that implementations match contracts:
|
|
116
116
|
|
|
117
117
|
```bash
|
|
118
|
-
|
|
118
|
+
sce collab verify user-service
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
### 6. Run Integration Tests
|
|
@@ -123,7 +123,7 @@ kse collab verify user-service
|
|
|
123
123
|
Run integration tests across multiple Specs:
|
|
124
124
|
|
|
125
125
|
```bash
|
|
126
|
-
|
|
126
|
+
sce collab integrate user-service auth-service session-manager
|
|
127
127
|
```
|
|
128
128
|
|
|
129
129
|
## Workflow Example
|
|
@@ -133,7 +133,7 @@ kse collab integrate user-service auth-service session-manager
|
|
|
133
133
|
**Step 1: Architect creates Master Spec**
|
|
134
134
|
|
|
135
135
|
```bash
|
|
136
|
-
|
|
136
|
+
sce collab init user-management \
|
|
137
137
|
--sub-specs database-layer user-service auth-service notification-service \
|
|
138
138
|
--dependencies "user-service:database-layer" \
|
|
139
139
|
--dependencies "auth-service:user-service" \
|
|
@@ -143,7 +143,7 @@ kse collab init user-management \
|
|
|
143
143
|
**Step 2: Check which Specs are ready**
|
|
144
144
|
|
|
145
145
|
```bash
|
|
146
|
-
|
|
146
|
+
sce collab status
|
|
147
147
|
```
|
|
148
148
|
|
|
149
149
|
Output:
|
|
@@ -163,79 +163,79 @@ Ready to start: database-layer
|
|
|
163
163
|
**Step 3: Assign and start development**
|
|
164
164
|
|
|
165
165
|
```bash
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
166
|
+
sce collab assign database-layer SCE-1
|
|
167
|
+
sce collab assign user-service SCE-2
|
|
168
|
+
sce collab assign auth-service SCE-3
|
|
169
169
|
```
|
|
170
170
|
|
|
171
171
|
**Step 4: Define interfaces**
|
|
172
172
|
|
|
173
|
-
Each
|
|
173
|
+
Each SCE instance defines the interface contract for their Spec.
|
|
174
174
|
|
|
175
175
|
**Step 5: Verify and integrate**
|
|
176
176
|
|
|
177
177
|
```bash
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
178
|
+
sce collab verify database-layer
|
|
179
|
+
sce collab verify user-service
|
|
180
|
+
sce collab integrate database-layer user-service
|
|
181
181
|
```
|
|
182
182
|
|
|
183
183
|
## Commands Reference
|
|
184
184
|
|
|
185
|
-
### `
|
|
185
|
+
### `sce collab init`
|
|
186
186
|
|
|
187
187
|
Initialize a Master Spec with Sub-Specs.
|
|
188
188
|
|
|
189
189
|
```bash
|
|
190
|
-
|
|
190
|
+
sce collab init <master-spec> [options]
|
|
191
191
|
```
|
|
192
192
|
|
|
193
193
|
Options:
|
|
194
194
|
- `-s, --sub-specs <specs...>`: Sub-spec names
|
|
195
195
|
- `-d, --dependencies <deps...>`: Dependencies in format "spec:dep1,dep2"
|
|
196
196
|
|
|
197
|
-
### `
|
|
197
|
+
### `sce collab status`
|
|
198
198
|
|
|
199
199
|
Display collaboration status.
|
|
200
200
|
|
|
201
201
|
```bash
|
|
202
|
-
|
|
202
|
+
sce collab status [spec-name] [options]
|
|
203
203
|
```
|
|
204
204
|
|
|
205
205
|
Options:
|
|
206
206
|
- `-g, --graph`: Show dependency graph
|
|
207
207
|
- `--critical-path`: Highlight critical path in graph
|
|
208
208
|
|
|
209
|
-
### `
|
|
209
|
+
### `sce collab assign`
|
|
210
210
|
|
|
211
|
-
Assign a Spec to a
|
|
211
|
+
Assign a Spec to a SCE instance.
|
|
212
212
|
|
|
213
213
|
```bash
|
|
214
|
-
|
|
214
|
+
sce collab assign <spec-name> <SCE-instance>
|
|
215
215
|
```
|
|
216
216
|
|
|
217
|
-
### `
|
|
217
|
+
### `sce collab verify`
|
|
218
218
|
|
|
219
219
|
Verify interface contracts for a Spec.
|
|
220
220
|
|
|
221
221
|
```bash
|
|
222
|
-
|
|
222
|
+
sce collab verify <spec-name>
|
|
223
223
|
```
|
|
224
224
|
|
|
225
|
-
### `
|
|
225
|
+
### `sce collab integrate`
|
|
226
226
|
|
|
227
227
|
Run integration tests across Specs.
|
|
228
228
|
|
|
229
229
|
```bash
|
|
230
|
-
|
|
230
|
+
sce collab integrate <spec-names...>
|
|
231
231
|
```
|
|
232
232
|
|
|
233
|
-
### `
|
|
233
|
+
### `sce collab migrate`
|
|
234
234
|
|
|
235
235
|
Convert a standalone Spec to collaborative mode.
|
|
236
236
|
|
|
237
237
|
```bash
|
|
238
|
-
|
|
238
|
+
sce collab migrate <spec-name>
|
|
239
239
|
```
|
|
240
240
|
|
|
241
241
|
## Best Practices
|
|
@@ -250,7 +250,7 @@ Keep dependencies minimal and well-justified. Too many dependencies create bottl
|
|
|
250
250
|
|
|
251
251
|
### 3. Regular Verification
|
|
252
252
|
|
|
253
|
-
Run `
|
|
253
|
+
Run `sce collab verify` frequently to catch interface mismatches early.
|
|
254
254
|
|
|
255
255
|
### 4. Integration Testing
|
|
256
256
|
|
|
@@ -258,11 +258,11 @@ Write integration tests that span multiple Specs to verify they work together co
|
|
|
258
258
|
|
|
259
259
|
### 5. Status Updates
|
|
260
260
|
|
|
261
|
-
Update Spec status regularly so other
|
|
261
|
+
Update Spec status regularly so other SCE instances know when dependencies are ready.
|
|
262
262
|
|
|
263
263
|
### 6. Critical Path Awareness
|
|
264
264
|
|
|
265
|
-
Use `
|
|
265
|
+
Use `sce collab status --graph --critical-path` to identify bottlenecks and prioritize work.
|
|
266
266
|
|
|
267
267
|
## Troubleshooting
|
|
268
268
|
|
|
@@ -276,7 +276,7 @@ Use `kse collab status --graph --critical-path` to identify bottlenecks and prio
|
|
|
276
276
|
|
|
277
277
|
**Error**: `Implementation does not match contract for 'UserService'`
|
|
278
278
|
|
|
279
|
-
**Solution**: Update either the implementation or the contract to match. Run `
|
|
279
|
+
**Solution**: Update either the implementation or the contract to match. Run `sce collab verify` to see specific mismatches.
|
|
280
280
|
|
|
281
281
|
### Spec Blocked
|
|
282
282
|
|
|
@@ -291,8 +291,8 @@ Use `kse collab status --graph --critical-path` to identify bottlenecks and prio
|
|
|
291
291
|
You can create nested structures with Sub-Sub-Specs:
|
|
292
292
|
|
|
293
293
|
```bash
|
|
294
|
-
|
|
295
|
-
|
|
294
|
+
sce collab init backend-system --sub-specs api-layer business-logic data-layer
|
|
295
|
+
sce collab init api-layer --sub-specs rest-api graphql-api
|
|
296
296
|
```
|
|
297
297
|
|
|
298
298
|
### Breaking Changes
|
|
@@ -301,8 +301,8 @@ When you need to make breaking changes to an interface:
|
|
|
301
301
|
|
|
302
302
|
1. Version the interface (e.g., `UserServiceV2.json`)
|
|
303
303
|
2. Update consumers to use the new version
|
|
304
|
-
3. Run `
|
|
305
|
-
4. Coordinate with affected
|
|
304
|
+
3. Run `sce collab verify` to detect breaking changes
|
|
305
|
+
4. Coordinate with affected SCE instances
|
|
306
306
|
|
|
307
307
|
### Custom Integration Tests
|
|
308
308
|
|
|
@@ -348,7 +348,7 @@ Collaboration metadata is stored in `.kiro/specs/{spec-name}/collaboration.json`
|
|
|
348
348
|
}
|
|
349
349
|
],
|
|
350
350
|
"assignment": {
|
|
351
|
-
"kiroInstance": "
|
|
351
|
+
"kiroInstance": "SCE-1",
|
|
352
352
|
"assignedAt": "2026-02-01T10:00:00Z"
|
|
353
353
|
},
|
|
354
354
|
"status": {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Spec Locking Guide
|
|
2
2
|
|
|
3
|
-
This guide explains how to use the Spec locking mechanism for multi-user collaboration in
|
|
3
|
+
This guide explains how to use the Spec locking mechanism for multi-user collaboration in sce projects.
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
@@ -10,13 +10,13 @@ When multiple developers work on the same project, they may accidentally edit th
|
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
# Before editing a Spec, acquire a lock
|
|
13
|
-
|
|
13
|
+
sce lock acquire my-feature --reason "Implementing user authentication"
|
|
14
14
|
|
|
15
15
|
# Check who has locks on which Specs
|
|
16
|
-
|
|
16
|
+
sce lock status
|
|
17
17
|
|
|
18
18
|
# When done editing, release the lock
|
|
19
|
-
|
|
19
|
+
sce unlock my-feature
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
## Commands
|
|
@@ -24,7 +24,7 @@ kse unlock my-feature
|
|
|
24
24
|
### Acquire a Lock
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
|
|
27
|
+
sce lock acquire <spec-name> [options]
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
Options:
|
|
@@ -33,15 +33,15 @@ Options:
|
|
|
33
33
|
|
|
34
34
|
Example:
|
|
35
35
|
```bash
|
|
36
|
-
|
|
36
|
+
sce lock acquire 01-00-user-auth --reason "Adding OAuth support" --timeout 48
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
### Release a Lock
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
|
|
42
|
+
sce unlock <spec-name> [options]
|
|
43
43
|
# or
|
|
44
|
-
|
|
44
|
+
sce lock release <spec-name> [options]
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Options:
|
|
@@ -49,18 +49,18 @@ Options:
|
|
|
49
49
|
|
|
50
50
|
Example:
|
|
51
51
|
```bash
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
sce unlock 01-00-user-auth
|
|
53
|
+
sce unlock 01-00-user-auth --force # Override someone else's lock
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
### Check Lock Status
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
59
|
# View all locked Specs
|
|
60
|
-
|
|
60
|
+
sce lock status
|
|
61
61
|
|
|
62
62
|
# View specific Spec lock status
|
|
63
|
-
|
|
63
|
+
sce lock status <spec-name>
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
Output includes:
|
|
@@ -73,7 +73,7 @@ Output includes:
|
|
|
73
73
|
### Clean Up Stale Locks
|
|
74
74
|
|
|
75
75
|
```bash
|
|
76
|
-
|
|
76
|
+
sce lock cleanup
|
|
77
77
|
```
|
|
78
78
|
|
|
79
79
|
Removes all locks that have exceeded their timeout period. This is useful when:
|
|
@@ -84,14 +84,14 @@ Removes all locks that have exceeded their timeout period. This is useful when:
|
|
|
84
84
|
### View Machine Identifier
|
|
85
85
|
|
|
86
86
|
```bash
|
|
87
|
-
|
|
87
|
+
sce lock whoami
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
Shows your machine's unique identifier, which is used to track lock ownership.
|
|
91
91
|
|
|
92
92
|
## Integration with Status Command
|
|
93
93
|
|
|
94
|
-
The `
|
|
94
|
+
The `sce status` command now shows lock indicators for each Spec:
|
|
95
95
|
|
|
96
96
|
```
|
|
97
97
|
📁 Specs (5)
|
|
@@ -117,19 +117,19 @@ Lock indicators:
|
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
119
|
# Good practice
|
|
120
|
-
|
|
120
|
+
sce lock acquire my-feature --reason "Refactoring task structure"
|
|
121
121
|
# ... make your changes ...
|
|
122
|
-
|
|
122
|
+
sce unlock my-feature
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
### 2. Use Meaningful Reasons
|
|
126
126
|
|
|
127
127
|
```bash
|
|
128
128
|
# Good - explains what you're doing
|
|
129
|
-
|
|
129
|
+
sce lock acquire api-spec --reason "Adding pagination to list endpoints"
|
|
130
130
|
|
|
131
131
|
# Bad - no context
|
|
132
|
-
|
|
132
|
+
sce lock acquire api-spec
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
### 3. Release Locks Promptly
|
|
@@ -140,10 +140,10 @@ Don't hold locks longer than necessary. Release as soon as you're done editing.
|
|
|
140
140
|
|
|
141
141
|
```bash
|
|
142
142
|
# Check if anyone is working on the Spec
|
|
143
|
-
|
|
143
|
+
sce lock status my-feature
|
|
144
144
|
|
|
145
145
|
# If unlocked, acquire and start working
|
|
146
|
-
|
|
146
|
+
sce lock acquire my-feature
|
|
147
147
|
```
|
|
148
148
|
|
|
149
149
|
### 5. Communicate Before Force Unlocking
|
|
@@ -155,10 +155,10 @@ If you need to force unlock someone else's lock:
|
|
|
155
155
|
|
|
156
156
|
```bash
|
|
157
157
|
# Check if stale
|
|
158
|
-
|
|
158
|
+
sce lock status their-spec
|
|
159
159
|
|
|
160
160
|
# If stale or confirmed with owner
|
|
161
|
-
|
|
161
|
+
sce unlock their-spec --force
|
|
162
162
|
```
|
|
163
163
|
|
|
164
164
|
## Configuration
|
|
@@ -168,8 +168,8 @@ kse unlock their-spec --force
|
|
|
168
168
|
Default timeout is 24 hours. You can customize per-lock:
|
|
169
169
|
|
|
170
170
|
```bash
|
|
171
|
-
|
|
172
|
-
|
|
171
|
+
sce lock acquire my-spec --timeout 48 # 48 hours
|
|
172
|
+
sce lock acquire quick-fix --timeout 2 # 2 hours
|
|
173
173
|
```
|
|
174
174
|
|
|
175
175
|
### Machine ID Storage
|
|
@@ -195,7 +195,7 @@ You're trying to unlock a Spec locked by another machine. Options:
|
|
|
195
195
|
|
|
196
196
|
Run periodic cleanup:
|
|
197
197
|
```bash
|
|
198
|
-
|
|
198
|
+
sce lock cleanup
|
|
199
199
|
```
|
|
200
200
|
|
|
201
201
|
Consider adding this to your CI/CD pipeline or team workflow.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Scene Capability Engine uses a two-part numbering system: `{major}-{minor}-{description}`
|
|
8
8
|
|
|
9
9
|
- **Major number**: Represents a feature domain or theme (01, 02, 03, ...)
|
|
10
10
|
- **Minor number**: Represents iterations or sub-features within that domain (00, 01, 02, ...)
|
|
@@ -169,7 +169,7 @@ Group Specs that:
|
|
|
169
169
|
|
|
170
170
|
## Practical Examples
|
|
171
171
|
|
|
172
|
-
### Example 1: Tool/Library Project (
|
|
172
|
+
### Example 1: Tool/Library Project (scene-capability-engine)
|
|
173
173
|
|
|
174
174
|
**Project Type**: CLI tool with independent features
|
|
175
175
|
|
|
@@ -314,17 +314,17 @@ If you started with simple numbering and need to add structure:
|
|
|
314
314
|
|
|
315
315
|
## Tool Support
|
|
316
316
|
|
|
317
|
-
|
|
317
|
+
Scene Capability Engine provides commands to help with numbering:
|
|
318
318
|
|
|
319
319
|
```bash
|
|
320
320
|
# List all Specs with their numbers
|
|
321
|
-
|
|
321
|
+
sce status
|
|
322
322
|
|
|
323
323
|
# View Specs grouped by major number
|
|
324
|
-
|
|
324
|
+
sce workflows
|
|
325
325
|
|
|
326
326
|
# Get next available number suggestion
|
|
327
|
-
|
|
327
|
+
sce workflows --suggest-next
|
|
328
328
|
```
|
|
329
329
|
|
|
330
330
|
## Summary
|
package/docs/spec-workflow.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Spec Workflow Guide
|
|
2
2
|
|
|
3
|
-
> Understanding the Spec-driven development workflow in
|
|
3
|
+
> Understanding the Spec-driven development workflow in sce
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
## Overview
|
|
15
15
|
|
|
16
|
-
A **Spec** (specification) is the fundamental unit of work in
|
|
16
|
+
A **Spec** (specification) is the fundamental unit of work in sce. It's a structured description of a feature or component that guides both human developers and AI assistants through the implementation process.
|
|
17
17
|
|
|
18
18
|
Every Spec follows a three-stage workflow: **Requirements → Design → Tasks**
|
|
19
19
|
|
|
@@ -251,7 +251,7 @@ Response: { ... }
|
|
|
251
251
|
|
|
252
252
|
**1. Create the Spec:**
|
|
253
253
|
```bash
|
|
254
|
-
|
|
254
|
+
sce spec bootstrap --name 01-00-user-login --non-interactive
|
|
255
255
|
```
|
|
256
256
|
|
|
257
257
|
**2. Write Requirements** (`.kiro/specs/01-00-user-login/requirements.md`):
|
|
@@ -292,7 +292,7 @@ Response: { token } or { error }
|
|
|
292
292
|
|
|
293
293
|
**5. Export Context:**
|
|
294
294
|
```bash
|
|
295
|
-
|
|
295
|
+
sce context export 01-00-user-login
|
|
296
296
|
```
|
|
297
297
|
|
|
298
298
|
**6. Implement with AI:**
|
|
@@ -302,22 +302,22 @@ kse context export 01-00-user-login
|
|
|
302
302
|
|
|
303
303
|
**7. Track Progress:**
|
|
304
304
|
```bash
|
|
305
|
-
|
|
305
|
+
sce status
|
|
306
306
|
```
|
|
307
307
|
|
|
308
308
|
**8. Maintain Document Governance:**
|
|
309
309
|
```bash
|
|
310
310
|
# Check for document violations
|
|
311
|
-
|
|
311
|
+
sce docs diagnose
|
|
312
312
|
|
|
313
313
|
# Clean up temporary files
|
|
314
|
-
|
|
314
|
+
sce docs cleanup --spec 01-00-user-login
|
|
315
315
|
|
|
316
316
|
# Organize artifacts (reports, scripts, etc.)
|
|
317
|
-
|
|
317
|
+
sce docs archive --spec 01-00-user-login
|
|
318
318
|
|
|
319
319
|
# Validate final structure
|
|
320
|
-
|
|
320
|
+
sce docs validate --spec 01-00-user-login
|
|
321
321
|
```
|
|
322
322
|
|
|
323
323
|
---
|
|
@@ -371,16 +371,16 @@ graph TD
|
|
|
371
371
|
```mermaid
|
|
372
372
|
sequenceDiagram
|
|
373
373
|
participant Dev as Developer
|
|
374
|
-
participant
|
|
374
|
+
participant sce as sce
|
|
375
375
|
participant AI as AI Tool
|
|
376
376
|
|
|
377
|
-
Dev->>
|
|
378
|
-
Dev->>
|
|
379
|
-
|
|
377
|
+
Dev->>sce: Create Spec (requirements, design, tasks)
|
|
378
|
+
Dev->>sce: sce context export spec-name
|
|
379
|
+
sce->>Dev: context-export.md
|
|
380
380
|
Dev->>AI: Provide context
|
|
381
381
|
AI->>Dev: Generate code
|
|
382
|
-
Dev->>
|
|
383
|
-
Dev->>
|
|
382
|
+
Dev->>sce: Update task status
|
|
383
|
+
Dev->>sce: sce status (check progress)
|
|
384
384
|
```
|
|
385
385
|
|
|
386
386
|
### Automated Workflow (Windsurf/Cline)
|
|
@@ -389,13 +389,13 @@ sequenceDiagram
|
|
|
389
389
|
sequenceDiagram
|
|
390
390
|
participant Dev as Developer
|
|
391
391
|
participant AI as AI Tool
|
|
392
|
-
participant
|
|
392
|
+
participant sce as sce
|
|
393
393
|
|
|
394
394
|
Dev->>AI: "Implement user login feature"
|
|
395
|
-
AI->>
|
|
396
|
-
|
|
395
|
+
AI->>sce: sce context export 01-00-user-login
|
|
396
|
+
sce->>AI: Return context
|
|
397
397
|
AI->>AI: Generate code
|
|
398
|
-
AI->>
|
|
398
|
+
AI->>sce: sce task claim 01-00-user-login 1.1
|
|
399
399
|
AI->>Dev: Code generated, task claimed
|
|
400
400
|
```
|
|
401
401
|
|
|
@@ -422,10 +422,10 @@ sequenceDiagram
|
|
|
422
422
|
4. **Be AI-friendly** - Tasks should be clear enough for AI to implement
|
|
423
423
|
|
|
424
424
|
### Document Governance
|
|
425
|
-
1. **Keep Specs clean** - Use `
|
|
426
|
-
2. **Remove temporary files** - Use `
|
|
427
|
-
3. **Validate structure** - Use `
|
|
428
|
-
4. **Install Git hooks** - Use `
|
|
425
|
+
1. **Keep Specs clean** - Use `sce docs archive` to organize artifacts
|
|
426
|
+
2. **Remove temporary files** - Use `sce docs cleanup` regularly
|
|
427
|
+
3. **Validate structure** - Use `sce docs validate` before committing
|
|
428
|
+
4. **Install Git hooks** - Use `sce docs hooks install` to prevent violations
|
|
429
429
|
|
|
430
430
|
### Throughout
|
|
431
431
|
1. **Keep it updated** - Specs are living documents
|
|
@@ -486,7 +486,7 @@ sequenceDiagram
|
|
|
486
486
|
- **[Quick Start Guide](quick-start.md)** - Get started with your first Spec
|
|
487
487
|
- **[Document Governance](document-governance.md)** - Keep your Specs clean and organized
|
|
488
488
|
- **[Integration Modes](integration-modes.md)** - How to use Specs with AI tools
|
|
489
|
-
- **[Command Reference](command-reference.md)** - All
|
|
489
|
+
- **[Command Reference](command-reference.md)** - All sce commands
|
|
490
490
|
- **[Examples](examples/)** - Complete example Specs
|
|
491
491
|
|
|
492
492
|
---
|
|
@@ -509,7 +509,7 @@ The Spec workflow is:
|
|
|
509
509
|
|
|
510
510
|
**Start your next Spec:** 🚀
|
|
511
511
|
```bash
|
|
512
|
-
|
|
512
|
+
sce spec bootstrap --name 02-00-your-feature --non-interactive
|
|
513
513
|
```
|
|
514
514
|
|
|
515
515
|
---
|