@codewalla_india/openspec 1.0.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.
Files changed (356) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +225 -0
  3. package/bin/openspec.js +5 -0
  4. package/dist/cli/index.d.ts +10 -0
  5. package/dist/cli/index.js +548 -0
  6. package/dist/commands/change.d.ts +39 -0
  7. package/dist/commands/change.js +279 -0
  8. package/dist/commands/completion.d.ts +72 -0
  9. package/dist/commands/completion.js +264 -0
  10. package/dist/commands/config.d.ts +36 -0
  11. package/dist/commands/config.js +552 -0
  12. package/dist/commands/context.d.ts +3 -0
  13. package/dist/commands/context.js +155 -0
  14. package/dist/commands/doctor.d.ts +8 -0
  15. package/dist/commands/doctor.js +163 -0
  16. package/dist/commands/feedback.d.ts +9 -0
  17. package/dist/commands/feedback.js +183 -0
  18. package/dist/commands/schema.d.ts +6 -0
  19. package/dist/commands/schema.js +869 -0
  20. package/dist/commands/shared-gather.d.ts +14 -0
  21. package/dist/commands/shared-gather.js +31 -0
  22. package/dist/commands/shared-output.d.ts +18 -0
  23. package/dist/commands/shared-output.js +61 -0
  24. package/dist/commands/show.d.ts +19 -0
  25. package/dist/commands/show.js +177 -0
  26. package/dist/commands/spec.d.ts +19 -0
  27. package/dist/commands/spec.js +236 -0
  28. package/dist/commands/store.d.ts +3 -0
  29. package/dist/commands/store.js +547 -0
  30. package/dist/commands/validate.d.ts +26 -0
  31. package/dist/commands/validate.js +330 -0
  32. package/dist/commands/workflow/index.d.ts +17 -0
  33. package/dist/commands/workflow/index.js +12 -0
  34. package/dist/commands/workflow/instructions.d.ts +45 -0
  35. package/dist/commands/workflow/instructions.js +500 -0
  36. package/dist/commands/workflow/new-change.d.ts +20 -0
  37. package/dist/commands/workflow/new-change.js +106 -0
  38. package/dist/commands/workflow/schemas.d.ts +10 -0
  39. package/dist/commands/workflow/schemas.js +34 -0
  40. package/dist/commands/workflow/shared.d.ts +84 -0
  41. package/dist/commands/workflow/shared.js +133 -0
  42. package/dist/commands/workflow/status.d.ts +16 -0
  43. package/dist/commands/workflow/status.js +92 -0
  44. package/dist/commands/workflow/templates.d.ts +16 -0
  45. package/dist/commands/workflow/templates.js +69 -0
  46. package/dist/commands/workset-input.d.ts +19 -0
  47. package/dist/commands/workset-input.js +112 -0
  48. package/dist/commands/workset-prompts.d.ts +12 -0
  49. package/dist/commands/workset-prompts.js +143 -0
  50. package/dist/commands/workset.d.ts +25 -0
  51. package/dist/commands/workset.js +446 -0
  52. package/dist/core/archive.d.ts +22 -0
  53. package/dist/core/archive.js +471 -0
  54. package/dist/core/artifact-graph/graph.d.ts +56 -0
  55. package/dist/core/artifact-graph/graph.js +141 -0
  56. package/dist/core/artifact-graph/index.d.ts +9 -0
  57. package/dist/core/artifact-graph/index.js +14 -0
  58. package/dist/core/artifact-graph/instruction-loader.d.ts +188 -0
  59. package/dist/core/artifact-graph/instruction-loader.js +233 -0
  60. package/dist/core/artifact-graph/outputs.d.ts +14 -0
  61. package/dist/core/artifact-graph/outputs.js +39 -0
  62. package/dist/core/artifact-graph/resolver.d.ts +81 -0
  63. package/dist/core/artifact-graph/resolver.js +257 -0
  64. package/dist/core/artifact-graph/schema.d.ts +13 -0
  65. package/dist/core/artifact-graph/schema.js +108 -0
  66. package/dist/core/artifact-graph/state.d.ts +12 -0
  67. package/dist/core/artifact-graph/state.js +31 -0
  68. package/dist/core/artifact-graph/types.d.ts +40 -0
  69. package/dist/core/artifact-graph/types.js +29 -0
  70. package/dist/core/available-tools.d.ts +17 -0
  71. package/dist/core/available-tools.js +43 -0
  72. package/dist/core/change-metadata/index.d.ts +2 -0
  73. package/dist/core/change-metadata/index.js +2 -0
  74. package/dist/core/change-metadata/schema.d.ts +19 -0
  75. package/dist/core/change-metadata/schema.js +30 -0
  76. package/dist/core/change-status-policy.d.ts +37 -0
  77. package/dist/core/change-status-policy.js +35 -0
  78. package/dist/core/command-generation/adapters/amazon-q.d.ts +13 -0
  79. package/dist/core/command-generation/adapters/amazon-q.js +26 -0
  80. package/dist/core/command-generation/adapters/antigravity.d.ts +13 -0
  81. package/dist/core/command-generation/adapters/antigravity.js +26 -0
  82. package/dist/core/command-generation/adapters/auggie.d.ts +13 -0
  83. package/dist/core/command-generation/adapters/auggie.js +27 -0
  84. package/dist/core/command-generation/adapters/bob.d.ts +14 -0
  85. package/dist/core/command-generation/adapters/bob.js +32 -0
  86. package/dist/core/command-generation/adapters/claude.d.ts +13 -0
  87. package/dist/core/command-generation/adapters/claude.js +37 -0
  88. package/dist/core/command-generation/adapters/cline.d.ts +14 -0
  89. package/dist/core/command-generation/adapters/cline.js +27 -0
  90. package/dist/core/command-generation/adapters/codebuddy.d.ts +13 -0
  91. package/dist/core/command-generation/adapters/codebuddy.js +28 -0
  92. package/dist/core/command-generation/adapters/codex.d.ts +16 -0
  93. package/dist/core/command-generation/adapters/codex.js +39 -0
  94. package/dist/core/command-generation/adapters/continue.d.ts +13 -0
  95. package/dist/core/command-generation/adapters/continue.js +28 -0
  96. package/dist/core/command-generation/adapters/costrict.d.ts +13 -0
  97. package/dist/core/command-generation/adapters/costrict.js +27 -0
  98. package/dist/core/command-generation/adapters/crush.d.ts +13 -0
  99. package/dist/core/command-generation/adapters/crush.js +30 -0
  100. package/dist/core/command-generation/adapters/cursor.d.ts +14 -0
  101. package/dist/core/command-generation/adapters/cursor.js +31 -0
  102. package/dist/core/command-generation/adapters/factory.d.ts +13 -0
  103. package/dist/core/command-generation/adapters/factory.js +27 -0
  104. package/dist/core/command-generation/adapters/gemini.d.ts +13 -0
  105. package/dist/core/command-generation/adapters/gemini.js +26 -0
  106. package/dist/core/command-generation/adapters/github-copilot.d.ts +13 -0
  107. package/dist/core/command-generation/adapters/github-copilot.js +26 -0
  108. package/dist/core/command-generation/adapters/iflow.d.ts +13 -0
  109. package/dist/core/command-generation/adapters/iflow.js +29 -0
  110. package/dist/core/command-generation/adapters/index.d.ts +32 -0
  111. package/dist/core/command-generation/adapters/index.js +32 -0
  112. package/dist/core/command-generation/adapters/junie.d.ts +13 -0
  113. package/dist/core/command-generation/adapters/junie.js +26 -0
  114. package/dist/core/command-generation/adapters/kilocode.d.ts +14 -0
  115. package/dist/core/command-generation/adapters/kilocode.js +23 -0
  116. package/dist/core/command-generation/adapters/kiro.d.ts +13 -0
  117. package/dist/core/command-generation/adapters/kiro.js +26 -0
  118. package/dist/core/command-generation/adapters/lingma.d.ts +13 -0
  119. package/dist/core/command-generation/adapters/lingma.js +30 -0
  120. package/dist/core/command-generation/adapters/opencode.d.ts +13 -0
  121. package/dist/core/command-generation/adapters/opencode.js +29 -0
  122. package/dist/core/command-generation/adapters/pi.d.ts +18 -0
  123. package/dist/core/command-generation/adapters/pi.js +42 -0
  124. package/dist/core/command-generation/adapters/qoder.d.ts +13 -0
  125. package/dist/core/command-generation/adapters/qoder.js +30 -0
  126. package/dist/core/command-generation/adapters/qwen.d.ts +13 -0
  127. package/dist/core/command-generation/adapters/qwen.js +26 -0
  128. package/dist/core/command-generation/adapters/roocode.d.ts +14 -0
  129. package/dist/core/command-generation/adapters/roocode.js +27 -0
  130. package/dist/core/command-generation/adapters/windsurf.d.ts +14 -0
  131. package/dist/core/command-generation/adapters/windsurf.js +38 -0
  132. package/dist/core/command-generation/generator.d.ts +21 -0
  133. package/dist/core/command-generation/generator.js +27 -0
  134. package/dist/core/command-generation/index.d.ts +22 -0
  135. package/dist/core/command-generation/index.js +24 -0
  136. package/dist/core/command-generation/registry.d.ts +36 -0
  137. package/dist/core/command-generation/registry.js +98 -0
  138. package/dist/core/command-generation/types.d.ts +56 -0
  139. package/dist/core/command-generation/types.js +8 -0
  140. package/dist/core/command-generation/yaml.d.ts +22 -0
  141. package/dist/core/command-generation/yaml.js +38 -0
  142. package/dist/core/completions/command-registry.d.ts +3 -0
  143. package/dist/core/completions/command-registry.js +778 -0
  144. package/dist/core/completions/completion-provider.d.ts +71 -0
  145. package/dist/core/completions/completion-provider.js +129 -0
  146. package/dist/core/completions/factory.d.ts +64 -0
  147. package/dist/core/completions/factory.js +75 -0
  148. package/dist/core/completions/generators/bash-generator.d.ts +35 -0
  149. package/dist/core/completions/generators/bash-generator.js +230 -0
  150. package/dist/core/completions/generators/fish-generator.d.ts +32 -0
  151. package/dist/core/completions/generators/fish-generator.js +160 -0
  152. package/dist/core/completions/generators/powershell-generator.d.ts +36 -0
  153. package/dist/core/completions/generators/powershell-generator.js +266 -0
  154. package/dist/core/completions/generators/zsh-generator.d.ts +47 -0
  155. package/dist/core/completions/generators/zsh-generator.js +276 -0
  156. package/dist/core/completions/installers/bash-installer.d.ts +87 -0
  157. package/dist/core/completions/installers/bash-installer.js +321 -0
  158. package/dist/core/completions/installers/fish-installer.d.ts +43 -0
  159. package/dist/core/completions/installers/fish-installer.js +151 -0
  160. package/dist/core/completions/installers/powershell-installer.d.ts +102 -0
  161. package/dist/core/completions/installers/powershell-installer.js +415 -0
  162. package/dist/core/completions/installers/zsh-installer.d.ts +117 -0
  163. package/dist/core/completions/installers/zsh-installer.js +424 -0
  164. package/dist/core/completions/shared-flags.d.ts +13 -0
  165. package/dist/core/completions/shared-flags.js +33 -0
  166. package/dist/core/completions/templates/bash-templates.d.ts +6 -0
  167. package/dist/core/completions/templates/bash-templates.js +30 -0
  168. package/dist/core/completions/templates/fish-templates.d.ts +7 -0
  169. package/dist/core/completions/templates/fish-templates.js +45 -0
  170. package/dist/core/completions/templates/powershell-templates.d.ts +6 -0
  171. package/dist/core/completions/templates/powershell-templates.js +34 -0
  172. package/dist/core/completions/templates/zsh-templates.d.ts +6 -0
  173. package/dist/core/completions/templates/zsh-templates.js +45 -0
  174. package/dist/core/completions/types.d.ts +101 -0
  175. package/dist/core/completions/types.js +2 -0
  176. package/dist/core/comprehension/config.d.ts +20 -0
  177. package/dist/core/comprehension/config.js +23 -0
  178. package/dist/core/comprehension/fingerprint.d.ts +5 -0
  179. package/dist/core/comprehension/fingerprint.js +25 -0
  180. package/dist/core/comprehension/index.d.ts +49 -0
  181. package/dist/core/comprehension/index.js +78 -0
  182. package/dist/core/comprehension/pass-record.d.ts +29 -0
  183. package/dist/core/comprehension/pass-record.js +64 -0
  184. package/dist/core/comprehension/stats.d.ts +18 -0
  185. package/dist/core/comprehension/stats.js +41 -0
  186. package/dist/core/config-prompts.d.ts +9 -0
  187. package/dist/core/config-prompts.js +34 -0
  188. package/dist/core/config-schema.d.ts +87 -0
  189. package/dist/core/config-schema.js +239 -0
  190. package/dist/core/config.d.ts +18 -0
  191. package/dist/core/config.js +39 -0
  192. package/dist/core/converters/json-converter.d.ts +6 -0
  193. package/dist/core/converters/json-converter.js +51 -0
  194. package/dist/core/file-state.d.ts +36 -0
  195. package/dist/core/file-state.js +112 -0
  196. package/dist/core/global-config.d.ts +51 -0
  197. package/dist/core/global-config.js +124 -0
  198. package/dist/core/id.d.ts +17 -0
  199. package/dist/core/id.js +30 -0
  200. package/dist/core/index.d.ts +6 -0
  201. package/dist/core/index.js +7 -0
  202. package/dist/core/init.d.ts +37 -0
  203. package/dist/core/init.js +613 -0
  204. package/dist/core/legacy-cleanup.d.ts +162 -0
  205. package/dist/core/legacy-cleanup.js +514 -0
  206. package/dist/core/list.d.ts +11 -0
  207. package/dist/core/list.js +185 -0
  208. package/dist/core/migration.d.ts +23 -0
  209. package/dist/core/migration.js +108 -0
  210. package/dist/core/openers.d.ts +77 -0
  211. package/dist/core/openers.js +251 -0
  212. package/dist/core/openspec-root.d.ts +45 -0
  213. package/dist/core/openspec-root.js +192 -0
  214. package/dist/core/parsers/change-parser.d.ts +13 -0
  215. package/dist/core/parsers/change-parser.js +197 -0
  216. package/dist/core/parsers/markdown-parser.d.ts +26 -0
  217. package/dist/core/parsers/markdown-parser.js +227 -0
  218. package/dist/core/parsers/requirement-blocks.d.ts +37 -0
  219. package/dist/core/parsers/requirement-blocks.js +201 -0
  220. package/dist/core/parsers/spec-structure.d.ts +9 -0
  221. package/dist/core/parsers/spec-structure.js +88 -0
  222. package/dist/core/planning-home.d.ts +16 -0
  223. package/dist/core/planning-home.js +67 -0
  224. package/dist/core/profile-sync-drift.d.ts +38 -0
  225. package/dist/core/profile-sync-drift.js +200 -0
  226. package/dist/core/profiles.d.ts +26 -0
  227. package/dist/core/profiles.js +40 -0
  228. package/dist/core/project-config.d.ts +120 -0
  229. package/dist/core/project-config.js +406 -0
  230. package/dist/core/references.d.ts +63 -0
  231. package/dist/core/references.js +310 -0
  232. package/dist/core/relationship-health.d.ts +65 -0
  233. package/dist/core/relationship-health.js +64 -0
  234. package/dist/core/root-selection.d.ts +122 -0
  235. package/dist/core/root-selection.js +337 -0
  236. package/dist/core/schemas/base.schema.d.ts +13 -0
  237. package/dist/core/schemas/base.schema.js +13 -0
  238. package/dist/core/schemas/change.schema.d.ts +73 -0
  239. package/dist/core/schemas/change.schema.js +31 -0
  240. package/dist/core/schemas/index.d.ts +4 -0
  241. package/dist/core/schemas/index.js +4 -0
  242. package/dist/core/schemas/spec.schema.d.ts +18 -0
  243. package/dist/core/schemas/spec.schema.js +15 -0
  244. package/dist/core/shared/index.d.ts +8 -0
  245. package/dist/core/shared/index.js +8 -0
  246. package/dist/core/shared/skill-generation.d.ts +49 -0
  247. package/dist/core/shared/skill-generation.js +96 -0
  248. package/dist/core/shared/tool-detection.d.ts +71 -0
  249. package/dist/core/shared/tool-detection.js +158 -0
  250. package/dist/core/specs-apply.d.ts +78 -0
  251. package/dist/core/specs-apply.js +394 -0
  252. package/dist/core/store/errors.d.ts +20 -0
  253. package/dist/core/store/errors.js +22 -0
  254. package/dist/core/store/foundation.d.ts +56 -0
  255. package/dist/core/store/foundation.js +251 -0
  256. package/dist/core/store/git.d.ts +23 -0
  257. package/dist/core/store/git.js +137 -0
  258. package/dist/core/store/index.d.ts +5 -0
  259. package/dist/core/store/index.js +5 -0
  260. package/dist/core/store/operations.d.ts +114 -0
  261. package/dist/core/store/operations.js +783 -0
  262. package/dist/core/store/registry.d.ts +58 -0
  263. package/dist/core/store/registry.js +275 -0
  264. package/dist/core/styles/palette.d.ts +7 -0
  265. package/dist/core/styles/palette.js +8 -0
  266. package/dist/core/templates/index.d.ts +8 -0
  267. package/dist/core/templates/index.js +9 -0
  268. package/dist/core/templates/skill-templates.d.ts +19 -0
  269. package/dist/core/templates/skill-templates.js +18 -0
  270. package/dist/core/templates/types.d.ts +19 -0
  271. package/dist/core/templates/types.js +5 -0
  272. package/dist/core/templates/workflows/apply-change.d.ts +10 -0
  273. package/dist/core/templates/workflows/apply-change.js +337 -0
  274. package/dist/core/templates/workflows/archive-change.d.ts +10 -0
  275. package/dist/core/templates/workflows/archive-change.js +278 -0
  276. package/dist/core/templates/workflows/bulk-archive-change.d.ts +10 -0
  277. package/dist/core/templates/workflows/bulk-archive-change.js +493 -0
  278. package/dist/core/templates/workflows/comprehension-guidance.d.ts +9 -0
  279. package/dist/core/templates/workflows/comprehension-guidance.js +58 -0
  280. package/dist/core/templates/workflows/continue-change.d.ts +10 -0
  281. package/dist/core/templates/workflows/continue-change.js +239 -0
  282. package/dist/core/templates/workflows/explore.d.ts +10 -0
  283. package/dist/core/templates/workflows/explore.js +464 -0
  284. package/dist/core/templates/workflows/feedback.d.ts +9 -0
  285. package/dist/core/templates/workflows/feedback.js +108 -0
  286. package/dist/core/templates/workflows/ff-change.d.ts +10 -0
  287. package/dist/core/templates/workflows/ff-change.js +205 -0
  288. package/dist/core/templates/workflows/mcp-guidance.d.ts +13 -0
  289. package/dist/core/templates/workflows/mcp-guidance.js +116 -0
  290. package/dist/core/templates/workflows/new-change.d.ts +10 -0
  291. package/dist/core/templates/workflows/new-change.js +148 -0
  292. package/dist/core/templates/workflows/onboard.d.ts +10 -0
  293. package/dist/core/templates/workflows/onboard.js +566 -0
  294. package/dist/core/templates/workflows/propose.d.ts +10 -0
  295. package/dist/core/templates/workflows/propose.js +228 -0
  296. package/dist/core/templates/workflows/store-selection.d.ts +8 -0
  297. package/dist/core/templates/workflows/store-selection.js +8 -0
  298. package/dist/core/templates/workflows/sync-specs.d.ts +10 -0
  299. package/dist/core/templates/workflows/sync-specs.js +291 -0
  300. package/dist/core/templates/workflows/verify-change.d.ts +10 -0
  301. package/dist/core/templates/workflows/verify-change.js +346 -0
  302. package/dist/core/update.d.ts +82 -0
  303. package/dist/core/update.js +557 -0
  304. package/dist/core/validation/constants.d.ts +34 -0
  305. package/dist/core/validation/constants.js +40 -0
  306. package/dist/core/validation/types.d.ts +18 -0
  307. package/dist/core/validation/types.js +2 -0
  308. package/dist/core/validation/validator.d.ts +44 -0
  309. package/dist/core/validation/validator.js +435 -0
  310. package/dist/core/view.d.ts +8 -0
  311. package/dist/core/view.js +168 -0
  312. package/dist/core/working-set.d.ts +47 -0
  313. package/dist/core/working-set.js +43 -0
  314. package/dist/core/worksets.d.ts +75 -0
  315. package/dist/core/worksets.js +245 -0
  316. package/dist/core/zod-issues.d.ts +4 -0
  317. package/dist/core/zod-issues.js +10 -0
  318. package/dist/index.d.ts +3 -0
  319. package/dist/index.js +3 -0
  320. package/dist/prompts/searchable-multi-select.d.ts +28 -0
  321. package/dist/prompts/searchable-multi-select.js +159 -0
  322. package/dist/telemetry/config.d.ts +38 -0
  323. package/dist/telemetry/config.js +136 -0
  324. package/dist/telemetry/index.d.ts +31 -0
  325. package/dist/telemetry/index.js +164 -0
  326. package/dist/ui/ascii-patterns.d.ts +16 -0
  327. package/dist/ui/ascii-patterns.js +133 -0
  328. package/dist/ui/welcome-screen.d.ts +10 -0
  329. package/dist/ui/welcome-screen.js +146 -0
  330. package/dist/utils/change-metadata.d.ts +55 -0
  331. package/dist/utils/change-metadata.js +141 -0
  332. package/dist/utils/change-utils.d.ts +71 -0
  333. package/dist/utils/change-utils.js +138 -0
  334. package/dist/utils/command-references.d.ts +18 -0
  335. package/dist/utils/command-references.js +20 -0
  336. package/dist/utils/file-system.d.ts +41 -0
  337. package/dist/utils/file-system.js +320 -0
  338. package/dist/utils/index.d.ts +6 -0
  339. package/dist/utils/index.js +9 -0
  340. package/dist/utils/interactive.d.ts +18 -0
  341. package/dist/utils/interactive.js +21 -0
  342. package/dist/utils/item-discovery.d.ts +4 -0
  343. package/dist/utils/item-discovery.js +72 -0
  344. package/dist/utils/match.d.ts +3 -0
  345. package/dist/utils/match.js +22 -0
  346. package/dist/utils/shell-detection.d.ts +20 -0
  347. package/dist/utils/shell-detection.js +41 -0
  348. package/dist/utils/task-progress.d.ts +8 -0
  349. package/dist/utils/task-progress.js +36 -0
  350. package/package.json +84 -0
  351. package/schemas/spec-driven/schema.yaml +153 -0
  352. package/schemas/spec-driven/templates/design.md +19 -0
  353. package/schemas/spec-driven/templates/proposal.md +23 -0
  354. package/schemas/spec-driven/templates/spec.md +8 -0
  355. package/schemas/spec-driven/templates/tasks.md +9 -0
  356. package/scripts/postinstall.js +83 -0
@@ -0,0 +1,566 @@
1
+ import { STORE_SELECTION_GUIDANCE } from './store-selection.js';
2
+ export function getOnboardSkillTemplate() {
3
+ return {
4
+ name: 'openspec-onboard',
5
+ description: 'Guided onboarding for OpenSpec - walk through a complete workflow cycle with narration and real codebase work.',
6
+ instructions: getOnboardInstructions(),
7
+ license: 'MIT',
8
+ compatibility: 'Requires openspec CLI.',
9
+ metadata: { author: 'openspec', version: '1.0' },
10
+ };
11
+ }
12
+ function getOnboardInstructions() {
13
+ return `Guide the user through their first complete OpenSpec workflow cycle. This is a teaching experience—you'll do real work in their codebase while explaining each step.
14
+
15
+ ${STORE_SELECTION_GUIDANCE}
16
+
17
+ ---
18
+
19
+ ## Preflight
20
+
21
+ Before starting, check if the OpenSpec CLI is installed:
22
+
23
+ \`\`\`bash
24
+ # Unix/macOS
25
+ openspec --version 2>&1 || echo "CLI_NOT_INSTALLED"
26
+ # Windows (PowerShell)
27
+ # if (Get-Command openspec -ErrorAction SilentlyContinue) { openspec --version } else { echo "CLI_NOT_INSTALLED" }
28
+ \`\`\`
29
+
30
+ **If CLI not installed:**
31
+ > OpenSpec CLI is not installed. Install it first, then come back to \`/opsx:onboard\`.
32
+
33
+ Stop here if not installed.
34
+
35
+ ---
36
+
37
+ ## Phase 1: Welcome
38
+
39
+ Display:
40
+
41
+ \`\`\`
42
+ ## Welcome to OpenSpec!
43
+
44
+ I'll walk you through a complete change cycle—from idea to implementation—using a real task in your codebase. Along the way, you'll learn the workflow by doing it.
45
+
46
+ **What we'll do:**
47
+ 1. Pick a small, real task in your codebase
48
+ 2. Explore the problem briefly
49
+ 3. Create a change (the container for our work)
50
+ 4. Build the artifacts: proposal → specs → design → tasks
51
+ 5. Implement the tasks
52
+ 6. Archive the completed change
53
+
54
+ **Time:** ~15-20 minutes
55
+
56
+ Let's start by finding something to work on.
57
+ \`\`\`
58
+
59
+ ---
60
+
61
+ ## Phase 2: Task Selection
62
+
63
+ ### Codebase Analysis
64
+
65
+ Scan the codebase for small improvement opportunities. Look for:
66
+
67
+ 1. **TODO/FIXME comments** - Search for \`TODO\`, \`FIXME\`, \`HACK\`, \`XXX\` in code files
68
+ 2. **Missing error handling** - \`catch\` blocks that swallow errors, risky operations without try-catch
69
+ 3. **Functions without tests** - Cross-reference \`src/\` with test directories
70
+ 4. **Type issues** - \`any\` types in TypeScript files (\`: any\`, \`as any\`)
71
+ 5. **Debug artifacts** - \`console.log\`, \`console.debug\`, \`debugger\` statements in non-debug code
72
+ 6. **Missing validation** - User input handlers without validation
73
+
74
+ Also check recent git activity:
75
+ \`\`\`bash
76
+ # Unix/macOS
77
+ git log --oneline -10 2>/dev/null || echo "No git history"
78
+ # Windows (PowerShell)
79
+ # git log --oneline -10 2>$null; if ($LASTEXITCODE -ne 0) { echo "No git history" }
80
+ \`\`\`
81
+
82
+ ### Present Suggestions
83
+
84
+ From your analysis, present 3-4 specific suggestions:
85
+
86
+ \`\`\`
87
+ ## Task Suggestions
88
+
89
+ Based on scanning your codebase, here are some good starter tasks:
90
+
91
+ **1. [Most promising task]**
92
+ Location: \`src/path/to/file.ts:42\`
93
+ Scope: ~1-2 files, ~20-30 lines
94
+ Why it's good: [brief reason]
95
+
96
+ **2. [Second task]**
97
+ Location: \`src/another/file.ts\`
98
+ Scope: ~1 file, ~15 lines
99
+ Why it's good: [brief reason]
100
+
101
+ **3. [Third task]**
102
+ Location: [location]
103
+ Scope: [estimate]
104
+ Why it's good: [brief reason]
105
+
106
+ **4. Something else?**
107
+ Tell me what you'd like to work on.
108
+
109
+ Which task interests you? (Pick a number or describe your own)
110
+ \`\`\`
111
+
112
+ **If nothing found:** Fall back to asking what the user wants to build:
113
+ > I didn't find obvious quick wins in your codebase. What's something small you've been meaning to add or fix?
114
+
115
+ ### Scope Guardrail
116
+
117
+ If the user picks or describes something too large (major feature, multi-day work):
118
+
119
+ \`\`\`
120
+ That's a valuable task, but it's probably larger than ideal for your first OpenSpec run-through.
121
+
122
+ For learning the workflow, smaller is better—it lets you see the full cycle without getting stuck in implementation details.
123
+
124
+ **Options:**
125
+ 1. **Slice it smaller** - What's the smallest useful piece of [their task]? Maybe just [specific slice]?
126
+ 2. **Pick something else** - One of the other suggestions, or a different small task?
127
+ 3. **Do it anyway** - If you really want to tackle this, we can. Just know it'll take longer.
128
+
129
+ What would you prefer?
130
+ \`\`\`
131
+
132
+ Let the user override if they insist—this is a soft guardrail.
133
+
134
+ ---
135
+
136
+ ## Phase 3: Explore Demo
137
+
138
+ Once a task is selected, briefly demonstrate explore mode:
139
+
140
+ \`\`\`
141
+ Before we create a change, let me quickly show you **explore mode**—it's how you think through problems before committing to a direction.
142
+ \`\`\`
143
+
144
+ Spend 1-2 minutes investigating the relevant code:
145
+ - Read the file(s) involved
146
+ - Draw a quick ASCII diagram if it helps
147
+ - Note any considerations
148
+
149
+ \`\`\`
150
+ ## Quick Exploration
151
+
152
+ [Your brief analysis—what you found, any considerations]
153
+
154
+ ┌─────────────────────────────────────────┐
155
+ │ [Optional: ASCII diagram if helpful] │
156
+ └─────────────────────────────────────────┘
157
+
158
+ Explore mode (\`/opsx:explore\`) is for this kind of thinking—investigating before implementing. You can use it anytime you need to think through a problem.
159
+
160
+ Now let's create a change to hold our work.
161
+ \`\`\`
162
+
163
+ **PAUSE** - Wait for user acknowledgment before proceeding.
164
+
165
+ ---
166
+
167
+ ## Phase 4: Create the Change
168
+
169
+ **EXPLAIN:**
170
+ \`\`\`
171
+ ## Creating a Change
172
+
173
+ A "change" in OpenSpec is a container for all the thinking and planning around a piece of work. It lives at the \`changeRoot\` reported by \`openspec status --change "<name>" --json\` and holds your artifacts—proposal, specs, design, tasks.
174
+
175
+ Let me create one for our task.
176
+ \`\`\`
177
+
178
+ **DO:** Create the change with a derived kebab-case name:
179
+ \`\`\`bash
180
+ openspec new change "<derived-name>"
181
+ \`\`\`
182
+
183
+ **SHOW:**
184
+ \`\`\`
185
+ Created: <changeRoot from status JSON>
186
+
187
+ The folder structure:
188
+ \`\`\`
189
+ <changeRoot>/
190
+ ├── proposal.md ← Why we're doing this (empty, we'll fill it)
191
+ ├── design.md ← How we'll build it (empty)
192
+ ├── specs/ ← Detailed requirements (empty)
193
+ └── tasks.md ← Implementation checklist (empty)
194
+ \`\`\`
195
+
196
+ Now let's fill in the first artifact—the proposal.
197
+ \`\`\`
198
+
199
+ ---
200
+
201
+ ## Phase 5: Proposal
202
+
203
+ **EXPLAIN:**
204
+ \`\`\`
205
+ ## The Proposal
206
+
207
+ The proposal captures **why** we're making this change and **what** it involves at a high level. It's the "elevator pitch" for the work.
208
+
209
+ I'll draft one based on our task.
210
+ \`\`\`
211
+
212
+ **DO:** Draft the proposal content (don't save yet):
213
+
214
+ \`\`\`
215
+ Here's a draft proposal:
216
+
217
+ ---
218
+
219
+ ## Why
220
+
221
+ [1-2 sentences explaining the problem/opportunity]
222
+
223
+ ## What Changes
224
+
225
+ [Bullet points of what will be different]
226
+
227
+ ## Capabilities
228
+
229
+ ### New Capabilities
230
+ - \`<capability-name>\`: [brief description]
231
+
232
+ ### Modified Capabilities
233
+ <!-- If modifying existing behavior -->
234
+
235
+ ## Impact
236
+
237
+ - \`src/path/to/file.ts\`: [what changes]
238
+ - [other files if applicable]
239
+
240
+ ---
241
+
242
+ Does this capture the intent? I can adjust before we save it.
243
+ \`\`\`
244
+
245
+ **PAUSE** - Wait for user approval/feedback.
246
+
247
+ After approval, save the proposal:
248
+ \`\`\`bash
249
+ openspec instructions proposal --change "<name>" --json
250
+ \`\`\`
251
+ Then write the content to the \`resolvedOutputPath\` from \`openspec instructions proposal --change "<name>" --json\`.
252
+
253
+ \`\`\`
254
+ Proposal saved. This is your "why" document—you can always come back and refine it as understanding evolves.
255
+
256
+ Next up: specs.
257
+ \`\`\`
258
+
259
+ ---
260
+
261
+ ## Phase 6: Specs
262
+
263
+ **EXPLAIN:**
264
+ \`\`\`
265
+ ## Specs
266
+
267
+ Specs define **what** we're building in precise, testable terms. They use a requirement/scenario format that makes expected behavior crystal clear.
268
+
269
+ For a small task like this, we might only need one spec file.
270
+ \`\`\`
271
+
272
+ **DO:** Resolve where the spec file should be created:
273
+ \`\`\`bash
274
+ openspec instructions specs --change "<name>" --json
275
+ # Use resolvedOutputPath from the JSON. If it is a glob, choose the concrete file path using the schema instruction and the change's context.
276
+ \`\`\`
277
+
278
+ Draft the spec content:
279
+
280
+ \`\`\`
281
+ Here's the spec:
282
+
283
+ ---
284
+
285
+ ## ADDED Requirements
286
+
287
+ ### Requirement: <Name>
288
+
289
+ <Description of what the system should do>
290
+
291
+ #### Scenario: <Scenario name>
292
+
293
+ - **WHEN** <trigger condition>
294
+ - **THEN** <expected outcome>
295
+ - **AND** <additional outcome if needed>
296
+
297
+ ---
298
+
299
+ This format—WHEN/THEN/AND—makes requirements testable. You can literally read them as test cases.
300
+ \`\`\`
301
+
302
+ Save to the concrete file path chosen from \`resolvedOutputPath\`.
303
+
304
+ ---
305
+
306
+ ## Phase 7: Design
307
+
308
+ **EXPLAIN:**
309
+ \`\`\`
310
+ ## Design
311
+
312
+ The design captures **how** we'll build it—technical decisions, tradeoffs, approach.
313
+
314
+ For small changes, this might be brief. That's fine—not every change needs deep design discussion.
315
+ \`\`\`
316
+
317
+ **DO:** Draft design.md:
318
+
319
+ \`\`\`
320
+ Here's the design:
321
+
322
+ ---
323
+
324
+ ## Context
325
+
326
+ [Brief context about the current state]
327
+
328
+ ## Goals / Non-Goals
329
+
330
+ **Goals:**
331
+ - [What we're trying to achieve]
332
+
333
+ **Non-Goals:**
334
+ - [What's explicitly out of scope]
335
+
336
+ ## Decisions
337
+
338
+ ### Decision 1: [Key decision]
339
+
340
+ [Explanation of approach and rationale]
341
+
342
+ ---
343
+
344
+ For a small task, this captures the key decisions without over-engineering.
345
+ \`\`\`
346
+
347
+ Save to the \`resolvedOutputPath\` from \`openspec instructions design --change "<name>" --json\`.
348
+
349
+ ---
350
+
351
+ ## Phase 8: Tasks
352
+
353
+ **EXPLAIN:**
354
+ \`\`\`
355
+ ## Tasks
356
+
357
+ Finally, we break the work into implementation tasks—checkboxes that drive the apply phase.
358
+
359
+ These should be small, clear, and in logical order.
360
+ \`\`\`
361
+
362
+ **DO:** Generate tasks based on specs and design:
363
+
364
+ \`\`\`
365
+ Here are the implementation tasks:
366
+
367
+ ---
368
+
369
+ ## 1. [Category or file]
370
+
371
+ - [ ] 1.1 [Specific task]
372
+ - [ ] 1.2 [Specific task]
373
+
374
+ ## 2. Verify
375
+
376
+ - [ ] 2.1 [Verification step]
377
+
378
+ ---
379
+
380
+ Each checkbox becomes a unit of work in the apply phase. Ready to implement?
381
+ \`\`\`
382
+
383
+ **PAUSE** - Wait for user to confirm they're ready to implement.
384
+
385
+ Save to the \`resolvedOutputPath\` from \`openspec instructions tasks --change "<name>" --json\`.
386
+
387
+ ---
388
+
389
+ ## Phase 9: Apply (Implementation)
390
+
391
+ **EXPLAIN:**
392
+ \`\`\`
393
+ ## Implementation
394
+
395
+ Now we implement each task, checking them off as we go. I'll announce each one and occasionally note how the specs/design informed the approach.
396
+ \`\`\`
397
+
398
+ **DO:** For each task:
399
+
400
+ 1. Announce: "Working on task N: [description]"
401
+ 2. Implement the change in the codebase
402
+ 3. Reference specs/design naturally: "The spec says X, so I'm doing Y"
403
+ 4. Mark complete in tasks.md: \`- [ ]\` → \`- [x]\`
404
+ 5. Brief status: "✓ Task N complete"
405
+
406
+ Keep narration light—don't over-explain every line of code.
407
+
408
+ After all tasks:
409
+
410
+ \`\`\`
411
+ ## Implementation Complete
412
+
413
+ All tasks done:
414
+ - [x] Task 1
415
+ - [x] Task 2
416
+ - [x] ...
417
+
418
+ The change is implemented! One more step—let's archive it.
419
+ \`\`\`
420
+
421
+ ---
422
+
423
+ ## Phase 10: Archive
424
+
425
+ **EXPLAIN:**
426
+ \`\`\`
427
+ ## Archiving
428
+
429
+ When a change is complete, we archive it. The archive path is derived from \`planningHome.changesDir\` and the date.
430
+
431
+ Archived changes become your project's decision history—you can always find them later to understand why something was built a certain way.
432
+ \`\`\`
433
+
434
+ **DO:**
435
+ \`\`\`bash
436
+ openspec archive "<name>"
437
+ \`\`\`
438
+
439
+ **SHOW:**
440
+ \`\`\`
441
+ Archived to: \`<planningHome.changesDir>/archive/YYYY-MM-DD-<name>/\`
442
+
443
+ The change is now part of your project's history. The code is in your codebase, the decision record is preserved.
444
+ \`\`\`
445
+
446
+ ---
447
+
448
+ ## Phase 11: Recap & Next Steps
449
+
450
+ \`\`\`
451
+ ## Congratulations!
452
+
453
+ You just completed a full OpenSpec cycle:
454
+
455
+ 1. **Explore** - Thought through the problem
456
+ 2. **New** - Created a change container
457
+ 3. **Proposal** - Captured WHY
458
+ 4. **Specs** - Defined WHAT in detail
459
+ 5. **Design** - Decided HOW
460
+ 6. **Tasks** - Broke it into steps
461
+ 7. **Apply** - Implemented the work
462
+ 8. **Archive** - Preserved the record
463
+
464
+ This same rhythm works for any size change—a small fix or a major feature.
465
+
466
+ ---
467
+
468
+ ## Command Reference
469
+
470
+ **Core workflow:**
471
+
472
+ | Command | What it does |
473
+ |-------------------|--------------------------------------------|
474
+ | \`/opsx:propose\` | Create a change and generate all artifacts |
475
+ | \`/opsx:explore\` | Think through problems before/during work |
476
+ | \`/opsx:apply\` | Implement tasks from a change |
477
+ | \`/opsx:archive\` | Archive a completed change |
478
+
479
+ **Additional commands:**
480
+
481
+ | Command | What it does |
482
+ |--------------------|----------------------------------------------------------|
483
+ | \`/opsx:new\` | Start a new change, step through artifacts one at a time |
484
+ | \`/opsx:continue\` | Continue working on an existing change |
485
+ | \`/opsx:ff\` | Fast-forward: create all artifacts at once |
486
+ | \`/opsx:verify\` | Verify implementation matches artifacts |
487
+
488
+ ---
489
+
490
+ ## What's Next?
491
+
492
+ Try \`/opsx:propose\` on something you actually want to build. You've got the rhythm now!
493
+ \`\`\`
494
+
495
+ ---
496
+
497
+ ## Graceful Exit Handling
498
+
499
+ ### User wants to stop mid-way
500
+
501
+ If the user says they need to stop, want to pause, or seem disengaged:
502
+
503
+ \`\`\`
504
+ No problem! Your change is saved at the \`changeRoot\` reported by \`openspec status --change "<name>" --json\`.
505
+
506
+ To pick up where we left off later:
507
+ - \`/opsx:continue <name>\` - Resume artifact creation
508
+ - \`/opsx:apply <name>\` - Jump to implementation (if tasks exist)
509
+
510
+ The work won't be lost. Come back whenever you're ready.
511
+ \`\`\`
512
+
513
+ Exit gracefully without pressure.
514
+
515
+ ### User just wants command reference
516
+
517
+ If the user says they just want to see the commands or skip the tutorial:
518
+
519
+ \`\`\`
520
+ ## OpenSpec Quick Reference
521
+
522
+ **Core workflow:**
523
+
524
+ | Command | What it does |
525
+ |--------------------------|--------------------------------------------|
526
+ | \`/opsx:propose <name>\` | Create a change and generate all artifacts |
527
+ | \`/opsx:explore\` | Think through problems (no code changes) |
528
+ | \`/opsx:apply <name>\` | Implement tasks |
529
+ | \`/opsx:archive <name>\` | Archive when done |
530
+
531
+ **Additional commands:**
532
+
533
+ | Command | What it does |
534
+ |---------------------------|-------------------------------------|
535
+ | \`/opsx:new <name>\` | Start a new change, step by step |
536
+ | \`/opsx:continue <name>\` | Continue an existing change |
537
+ | \`/opsx:ff <name>\` | Fast-forward: all artifacts at once |
538
+ | \`/opsx:verify <name>\` | Verify implementation |
539
+
540
+ Try \`/opsx:propose\` to start your first change.
541
+ \`\`\`
542
+
543
+ Exit gracefully.
544
+
545
+ ---
546
+
547
+ ## Guardrails
548
+
549
+ - **Follow the EXPLAIN → DO → SHOW → PAUSE pattern** at key transitions (after explore, after proposal draft, after tasks, after archive)
550
+ - **Keep narration light** during implementation—teach without lecturing
551
+ - **Don't skip phases** even if the change is small—the goal is teaching the workflow
552
+ - **Pause for acknowledgment** at marked points, but don't over-pause
553
+ - **Handle exits gracefully**—never pressure the user to continue
554
+ - **Use real codebase tasks**—don't simulate or use fake examples
555
+ - **Adjust scope gently**—guide toward smaller tasks but respect user choice`;
556
+ }
557
+ export function getOpsxOnboardCommandTemplate() {
558
+ return {
559
+ name: 'OPSX: Onboard',
560
+ description: 'Guided onboarding - walk through a complete OpenSpec workflow cycle with narration',
561
+ category: 'Workflow',
562
+ tags: ['workflow', 'onboarding', 'tutorial', 'learning'],
563
+ content: getOnboardInstructions(),
564
+ };
565
+ }
566
+ //# sourceMappingURL=onboard.js.map
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Skill Template Workflow Modules
3
+ *
4
+ * This file is generated by splitting the legacy monolithic
5
+ * templates file into workflow-focused modules.
6
+ */
7
+ import type { SkillTemplate, CommandTemplate } from '../types.js';
8
+ export declare function getOpsxProposeSkillTemplate(): SkillTemplate;
9
+ export declare function getOpsxProposeCommandTemplate(): CommandTemplate;
10
+ //# sourceMappingURL=propose.d.ts.map