ac-framework 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/framework/{AGENTS.md → .agent/workflows/ac.md} +2 -168
- package/framework/{CLAUDE.md → .amazonq/prompts/ac.md} +2 -168
- package/framework/{GEMINI.md → .augment/commands/ac.md} +2 -168
- package/framework/{QWEN.md → .claude/commands/opsx/ac.md} +2 -168
- package/framework/.clinerules/workflows/ac.md +298 -0
- package/framework/.codebuddy/commands/opsx/ac.md +298 -0
- package/framework/.continue/prompts/ac.md +298 -0
- package/framework/.cospec/openspec/commands/ac.md +298 -0
- package/framework/.crush/commands/opsx/ac.md +298 -0
- package/framework/.cursor/commands/ac.md +298 -0
- package/framework/.factory/commands/ac.md +298 -0
- package/framework/.gemini/commands/opsx/ac.md +298 -0
- package/framework/.github/prompts/ac.md +298 -0
- package/framework/.iflow/commands/ac.md +298 -0
- package/framework/.kilocode/workflows/ac.md +298 -0
- package/framework/.opencode/command/ac.md +298 -0
- package/framework/.qoder/commands/opsx/ac.md +298 -0
- package/framework/.qwen/commands/ac.md +298 -0
- package/framework/.roo/commands/ac.md +298 -0
- package/framework/.windsurf/workflows/ac.md +298 -0
- package/package.json +3 -2
- package/src/cli.js +13 -2
- package/src/commands/init.js +239 -173
- package/src/commands/update.js +213 -0
- package/src/config/constants.js +10 -0
- package/src/index.js +3 -2
- package/src/services/github-sync.js +235 -0
- package/src/services/installer.js +19 -9
- package/src/ui/banner.js +140 -37
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
**Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
2
|
+
---
|
|
3
|
+
|
|
4
|
+
## 🛠️ Available Skills
|
|
5
|
+
|
|
6
|
+
### Quality and Security Skills
|
|
7
|
+
|
|
8
|
+
| Skill | Description | Primary Use |
|
|
9
|
+
|-------|-------------|---------------|
|
|
10
|
+
| `secure-coding-cybersecurity` | Detects and prevents security vulnerabilities (SQLi, XSS, command injection, hardcoded secrets). Follows OWASP Top 10 standards. | Secure code validation |
|
|
11
|
+
| `code-maintainability` | Analyzes code maintainability: duplication, documentation, error handling, naming conventions, SOLID architecture, performance. | Refactoring and standards |
|
|
12
|
+
| `error-handling-patterns` | Error handling patterns in multiple languages: exceptions, Result types, retry, circuit breaker, graceful degradation. | Application resilience |
|
|
13
|
+
|
|
14
|
+
### Planning and Design Skills
|
|
15
|
+
|
|
16
|
+
| Skill | Description | Primary Use |
|
|
17
|
+
|-------|-------------|---------------|
|
|
18
|
+
| `brainstorming` | Generates ideas and questions decisions before implementing. Explores requirements, constraints, and success criteria. | Design and architecture |
|
|
19
|
+
| `api-design-principles` | REST and GraphQL design principles: resources, endpoints, pagination, versioning, HATEOAS. | API design |
|
|
20
|
+
| `interface-design` | Interface design (dashboards, admin panels, apps). NOT for landing pages/marketing. | UI design |
|
|
21
|
+
|
|
22
|
+
### OpenSpec Skills (The heart of the framework)
|
|
23
|
+
|
|
24
|
+
| Skill | Description | Primary Use |
|
|
25
|
+
|-------|-------------|---------------|
|
|
26
|
+
| `openspec-explore` | Exploration mode to investigate problems, map architecture, find integration points before implementing. | Pre-analysis |
|
|
27
|
+
| `openspec-new-change` | Creates a new change with step-by-step workflow (proposal → specs → design → tasks). | Structured start |
|
|
28
|
+
| `openspec-ff-change` | Fast-forward: creates all artifacts at once to start implementation quickly. | Quick start |
|
|
29
|
+
| `openspec-continue-change` | Continues an existing change by creating the next artifact in the sequence. | Continue workflow |
|
|
30
|
+
| `openspec-apply-change` | Implements tasks from a change (applies code according to specs and tasks). | Change execution |
|
|
31
|
+
| `openspec-verify-change` | Verifies that implementation matches artifacts (specs, tasks, design). | Validation |
|
|
32
|
+
| `openspec-archive-change` | Archives a completed change by moving it to `openspec/changes/archive/`. | Change closure |
|
|
33
|
+
| `openspec-onboard` | Guided tutorial to learn OpenSpec with a complete example workflow. | Learning |
|
|
34
|
+
| `openspec-sync-specs` | Synchronizes delta specs to main specs (intelligent merge). | Update specs |
|
|
35
|
+
| `openspec-bulk-archive-change` | Archives multiple completed changes at once. | Bulk cleanup |
|
|
36
|
+
|
|
37
|
+
### Documentation and Debugging Skills
|
|
38
|
+
|
|
39
|
+
| Skill | Description | Primary Use |
|
|
40
|
+
|-------|-------------|---------------|
|
|
41
|
+
| `project-index` | Generates structured project documentation: structure analysis, domains, agent guides. | Indexing and context |
|
|
42
|
+
| `systematic-debugging` | Structured debugging in 4 phases: root cause investigation, pattern analysis, hypothesis, implementation. | Problem resolution |
|
|
43
|
+
| `changelog-generator` | Creates automated changelogs from git commits, translating technical to user language. | Version history |
|
|
44
|
+
| `skill-writer` | Guide to create new skills for Claude Code with correct structure and frontmatter. | Create new skills |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 🚀 Workflow: New Project
|
|
49
|
+
|
|
50
|
+
When starting a project **from scratch**, follow this mandatory workflow:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
54
|
+
│ WORKFLOW: NEW PROJECT │
|
|
55
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
56
|
+
|
|
57
|
+
┌─────────────────┐
|
|
58
|
+
│ START │
|
|
59
|
+
└────────┬────────┘
|
|
60
|
+
│
|
|
61
|
+
▼
|
|
62
|
+
┌──────────────────────────────────────────────┐
|
|
63
|
+
│ PHASE 1: FOUNDATIONS (Mandatory) │
|
|
64
|
+
│ │
|
|
65
|
+
│ 1. secure-coding-cybersecurity │
|
|
66
|
+
│ └─ Establish security guidelines │
|
|
67
|
+
│ │
|
|
68
|
+
│ 2. code-maintainability │
|
|
69
|
+
│ └─ Define quality standards │
|
|
70
|
+
│ │
|
|
71
|
+
│ 3. brainstorming │
|
|
72
|
+
│ └─ Architecture and design decisions │
|
|
73
|
+
└────────────────────┬─────────────────────────┘
|
|
74
|
+
│
|
|
75
|
+
▼
|
|
76
|
+
┌──────────────────────────────────────────────┐
|
|
77
|
+
│ PHASE 2: SPECIFICATION (Mandatory) │
|
|
78
|
+
│ │
|
|
79
|
+
│ 4. openspec-new-change │
|
|
80
|
+
│ └─ Create change with proposal │
|
|
81
|
+
│ │
|
|
82
|
+
│ 5. openspec-continue-change │
|
|
83
|
+
│ └─ Create specs, design, tasks │
|
|
84
|
+
│ (or use openspec-ff-change) │
|
|
85
|
+
└────────────────────┬─────────────────────────┘
|
|
86
|
+
│
|
|
87
|
+
▼
|
|
88
|
+
┌──────────────────────────────────────────────┐
|
|
89
|
+
│ PHASE 3: IMPLEMENTATION │
|
|
90
|
+
│ │
|
|
91
|
+
│ 6. openspec-apply-change │
|
|
92
|
+
│ └─ Implement the tasks │
|
|
93
|
+
└────────────────────┬─────────────────────────┘
|
|
94
|
+
│
|
|
95
|
+
▼
|
|
96
|
+
┌──────────────────────────────────────────────┐
|
|
97
|
+
│ PHASE 4: VALIDATION AND CLOSURE │
|
|
98
|
+
│ │
|
|
99
|
+
│ 7. systematic-debugging │
|
|
100
|
+
│ └─ Verify no errors │
|
|
101
|
+
│ │
|
|
102
|
+
│ 8. openspec-verify-change │
|
|
103
|
+
│ └─ Validate against specs │
|
|
104
|
+
│ │
|
|
105
|
+
│ 9. changelog-generator │
|
|
106
|
+
│ └─ Generate in changelogs/by-ai/ │
|
|
107
|
+
│ │
|
|
108
|
+
│ 10. openspec-archive-change │
|
|
109
|
+
│ └─ Archive the change │
|
|
110
|
+
└──────────────────────────────────────────────┘
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Phase Descriptions - New Project
|
|
114
|
+
|
|
115
|
+
| Phase | Skill | Description | Expected Output |
|
|
116
|
+
|------|-------|-------------|-----------------|
|
|
117
|
+
| 1 | `secure-coding-cybersecurity` | Establish security guidelines: input validation, sanitization, injection prevention, secrets handling | `.agents/security-guidelines.md` |
|
|
118
|
+
| 2 | `code-maintainability` | Define conventions: naming, folder structure, design patterns, DRY, testing | `.agents/maintainability-rules.md` |
|
|
119
|
+
| 3 | `brainstorming` | Generate architecture ideas, question approach, explore alternatives | `.agents/architecture-decisions.md` |
|
|
120
|
+
| 4 | `openspec-new-change` | Create change with proposal (why, what changes, capabilities) | `openspec/changes/<name>/proposal.md` |
|
|
121
|
+
| 5 | `openspec-continue-change` | Create specs (WHEN/THEN requirements), design (technical decisions), tasks (checklist) | Complete OpenSpec artifacts |
|
|
122
|
+
| 6 | `openspec-apply-change` | Implement code according to specs and tasks | Functional code |
|
|
123
|
+
| 7 | `systematic-debugging` | Structured debugging: investigate root cause, don't guess | Validation report |
|
|
124
|
+
| 8 | `openspec-verify-change` | Verify completeness, correctness, and coherence | Verification report |
|
|
125
|
+
| 9 | `changelog-generator` | Document changes in user language | `changelogs/by-ai/[date]-[feature].md` |
|
|
126
|
+
| 10 | `openspec-archive-change` | Move change to archive with date | `openspec/changes/archive/YYYY-MM-DD-<name>/` |
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 🔍 Workflow: Existing Project
|
|
131
|
+
|
|
132
|
+
When working on an **already created** project that does NOT have `.md` documentation files:
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
136
|
+
│ WORKFLOW: EXISTING PROJECT (NO DOCS) │
|
|
137
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
138
|
+
|
|
139
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
140
|
+
│ │
|
|
141
|
+
│ ⚠️ CHECK: No documentation .md files exist in │
|
|
142
|
+
│ .agents/ or openspec/ │
|
|
143
|
+
│ │
|
|
144
|
+
└────────────────────────────────────────────────────┬─────────────────────┘
|
|
145
|
+
│
|
|
146
|
+
▼
|
|
147
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
148
|
+
│ │
|
|
149
|
+
│ 🔄 STEP 0: project-index │
|
|
150
|
+
│ Generate complete documentation for existing project │
|
|
151
|
+
│ ├─ Analyze folder structure │
|
|
152
|
+
│ ├─ Identify domains (UI, Backend, DB, etc.) │
|
|
153
|
+
│ ├─ Create specific sub-skills per domain │
|
|
154
|
+
│ └─ Generate agent-guidance files │
|
|
155
|
+
│ │
|
|
156
|
+
│ Output: │
|
|
157
|
+
│ ├─ .agents/project-index.md │
|
|
158
|
+
│ ├─ .agents/agent-<domain>.md (in each folder) │
|
|
159
|
+
│ └─ .claude/skills/project-index-<domain>/SKILL.md │
|
|
160
|
+
│ │
|
|
161
|
+
└─────────────────────────────────────────────────────────────────────────┘
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Post-Indexing
|
|
165
|
+
|
|
166
|
+
Once the project is indexed, continue with the [Changes Workflow](#-workflow-changesiterations).
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## 🔄 Workflow: Changes/Iterations
|
|
171
|
+
|
|
172
|
+
For **each change or new feature** in an already documented project:
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
176
|
+
│ WORKFLOW: CHANGES AND ITERATIONS │
|
|
177
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
178
|
+
|
|
179
|
+
┌─────────────────────────┐
|
|
180
|
+
│ START CHANGE │
|
|
181
|
+
└────────┬────────────────┘
|
|
182
|
+
│
|
|
183
|
+
▼
|
|
184
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
185
|
+
│ 1. openspec-explore │────▶│ 2. brainstorming │
|
|
186
|
+
│ (Explore current │ │ (Based on exploration: │
|
|
187
|
+
│ code and structure) │ │ - Generate ideas │
|
|
188
|
+
└─────────────────────────┘ │ - Suggest improvements │
|
|
189
|
+
│ - Ask key questions to user) │
|
|
190
|
+
└─────────────────┬────────────────────────┘
|
|
191
|
+
│
|
|
192
|
+
▼
|
|
193
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
194
|
+
│ 3. openspec-new │────▶│ 4. openspec-continue / ff │
|
|
195
|
+
│ (Create specification │ │ (Create specs, design, tasks) │
|
|
196
|
+
│ for change/feature) │ └─────────────────┬────────────────────────┘
|
|
197
|
+
└─────────────────────────┘ │
|
|
198
|
+
▼
|
|
199
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
200
|
+
│ 5. openspec-apply │────▶│ 6. systematic-debugging │
|
|
201
|
+
│ (Implement changes │ │ (Verify no errors, │
|
|
202
|
+
│ according to tasks) │ │ validate patterns) │
|
|
203
|
+
└─────────────────────────┘ └─────────────────┬────────────────────────┘
|
|
204
|
+
│
|
|
205
|
+
▼
|
|
206
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
207
|
+
│ 7. openspec-verify │────▶│ 8. changelog-generator │
|
|
208
|
+
│ (Verify against │ │ (Generate change record │
|
|
209
|
+
│ specs and design) │ │ in changelogs/by-ai/) │
|
|
210
|
+
└─────────────────────────┘ └─────────────────┬────────────────────────┘
|
|
211
|
+
│
|
|
212
|
+
▼
|
|
213
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
214
|
+
│ 9. openspec-archive │────▶│ 10. openspec-sync-specs (optional) │
|
|
215
|
+
│ (Archive completed │ │ (Sync specs to main) │
|
|
216
|
+
│ change) │ └──────────────────────────────────────────┘
|
|
217
|
+
└─────────────────────────┘
|
|
218
|
+
│
|
|
219
|
+
▼
|
|
220
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
221
|
+
│ │
|
|
222
|
+
│ ✅ CHANGE COMPLETED AND DOCUMENTED │
|
|
223
|
+
│ │
|
|
224
|
+
└─────────────────────────────────────────────────────────────────────────┘
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Phase Descriptions - Changes/Iterations
|
|
228
|
+
|
|
229
|
+
| Phase | Skill | Description | Required Input | Expected Output |
|
|
230
|
+
|------|-------|-------------|-----------------|-----------------|
|
|
231
|
+
| 1 | `openspec-explore` | Analyze current code state, identify dependencies and modification points | Change request context | Impact report in `.agents/exploration-report.md` |
|
|
232
|
+
| 2 | `brainstorming` | Generate ideas based on exploration, suggest alternatives, ask user questions | Exploration report | `.agents/brainstorming-session.md` with decisions |
|
|
233
|
+
| 3 | `openspec-new-change` | Create change container with initial proposal | Brainstorming decisions | `openspec/changes/<name>/proposal.md` |
|
|
234
|
+
| 4 | `openspec-continue-change` or `openspec-ff-change` | Create specs, design, and tasks | Approved proposal | Complete OpenSpec artifacts |
|
|
235
|
+
| 5 | `openspec-apply-change` | Implement tasks as described | Tasks ready | Modified code following specs |
|
|
236
|
+
| 6 | `systematic-debugging` | Validate no errors, verify applied patterns | Modified code | Validation report in `.agents/debug-report.md` |
|
|
237
|
+
| 7 | `openspec-verify-change` | Verify implementation matches specs and design | Artifacts + code | Verification report |
|
|
238
|
+
| 8 | `changelog-generator` | Document change in history | Implemented feature | `changelogs/by-ai/[YYYY-MM-DD]-[feature].md` |
|
|
239
|
+
| 9 | `openspec-archive-change` | Archive completed change | Change ready | `openspec/changes/archive/YYYY-MM-DD-<name>/` |
|
|
240
|
+
| 10 | `openspec-sync-specs` (optional) | Synchronize delta specs to main specs | Delta specs | Main specs updated |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## ✅ Validation Checklist
|
|
245
|
+
|
|
246
|
+
Before considering any task as **completed**, verify:
|
|
247
|
+
|
|
248
|
+
```
|
|
249
|
+
╔═══════════════════════════════════════════════════════════════════════════════════╗
|
|
250
|
+
║ MANDATORY CHECKLIST ║
|
|
251
|
+
╠═══════════════════════════════════════════════════════════════════════════════════╣
|
|
252
|
+
║ ║
|
|
253
|
+
║ □ Security ║
|
|
254
|
+
║ └─ □ secure-coding-cybersecurity executed ║
|
|
255
|
+
║ └─ □ No known vulnerabilities (SQL injection, XSS, etc.) ║
|
|
256
|
+
║ └─ □ Inputs validated and sanitized ║
|
|
257
|
+
║ └─ □ Secrets/keys not hardcoded ║
|
|
258
|
+
║ └─ □ No eval() or dynamic code execution with user input ║
|
|
259
|
+
║ ║
|
|
260
|
+
║ □ Maintainability ║
|
|
261
|
+
║ └─ □ code-maintainability executed ║
|
|
262
|
+
║ └─ □ Code follows project conventions ║
|
|
263
|
+
║ └─ □ Functions/classes have single responsibility ║
|
|
264
|
+
║ └─ □ Descriptive and semantic names ║
|
|
265
|
+
║ └─ □ No duplicate code (DRY principle) ║
|
|
266
|
+
║ └─ □ Documentation explains "why", not "what" ║
|
|
267
|
+
║ ║
|
|
268
|
+
║ □ Error Handling ║
|
|
269
|
+
║ └─ □ error-handling-patterns applied ║
|
|
270
|
+
║ └─ □ All errors handled gracefully ║
|
|
271
|
+
║ └─ □ Edge cases covered (null, empty, boundaries) ║
|
|
272
|
+
║ ║
|
|
273
|
+
║ □ Specification (OpenSpec) ║
|
|
274
|
+
║ └─ □ Change created with proposal, specs, design, tasks ║
|
|
275
|
+
║ └─ □ Implementation matches specification ║
|
|
276
|
+
║ └─ □ All WHEN/THEN scenarios implemented ║
|
|
277
|
+
║ └─ □ Design decisions documented ║
|
|
278
|
+
║ ║
|
|
279
|
+
║ □ Implementation ║
|
|
280
|
+
║ └─ □ All tasks marked complete [- [x]] ║
|
|
281
|
+
║ └─ □ Code tested and functional ║
|
|
282
|
+
║ └─ □ No console.logs or debug code ║
|
|
283
|
+
║ ║
|
|
284
|
+
║ □ Validation ║
|
|
285
|
+
║ └─ □ systematic-debugging executed without critical errors ║
|
|
286
|
+
║ └─ □ openspec-verify-change passed (or reviewed) ║
|
|
287
|
+
║ └─ □ Design patterns correctly applied ║
|
|
288
|
+
║ ║
|
|
289
|
+
║ □ Documentation ║
|
|
290
|
+
║ └─ □ Project index updated if structure changed ║
|
|
291
|
+
║ └─ □ Changelog generated in changelogs/by-ai/ ║
|
|
292
|
+
║ └─ □ README updated if necessary ║
|
|
293
|
+
║ ║
|
|
294
|
+
║ □ Closure ║
|
|
295
|
+
║ └─ □ Change archived with openspec-archive-change ║
|
|
296
|
+
║ └─ □ Delta specs synchronized (if applicable) ║
|
|
297
|
+
║ ║
|
|
298
|
+
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
**Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
2
|
+
---
|
|
3
|
+
|
|
4
|
+
## 🛠️ Available Skills
|
|
5
|
+
|
|
6
|
+
### Quality and Security Skills
|
|
7
|
+
|
|
8
|
+
| Skill | Description | Primary Use |
|
|
9
|
+
|-------|-------------|---------------|
|
|
10
|
+
| `secure-coding-cybersecurity` | Detects and prevents security vulnerabilities (SQLi, XSS, command injection, hardcoded secrets). Follows OWASP Top 10 standards. | Secure code validation |
|
|
11
|
+
| `code-maintainability` | Analyzes code maintainability: duplication, documentation, error handling, naming conventions, SOLID architecture, performance. | Refactoring and standards |
|
|
12
|
+
| `error-handling-patterns` | Error handling patterns in multiple languages: exceptions, Result types, retry, circuit breaker, graceful degradation. | Application resilience |
|
|
13
|
+
|
|
14
|
+
### Planning and Design Skills
|
|
15
|
+
|
|
16
|
+
| Skill | Description | Primary Use |
|
|
17
|
+
|-------|-------------|---------------|
|
|
18
|
+
| `brainstorming` | Generates ideas and questions decisions before implementing. Explores requirements, constraints, and success criteria. | Design and architecture |
|
|
19
|
+
| `api-design-principles` | REST and GraphQL design principles: resources, endpoints, pagination, versioning, HATEOAS. | API design |
|
|
20
|
+
| `interface-design` | Interface design (dashboards, admin panels, apps). NOT for landing pages/marketing. | UI design |
|
|
21
|
+
|
|
22
|
+
### OpenSpec Skills (The heart of the framework)
|
|
23
|
+
|
|
24
|
+
| Skill | Description | Primary Use |
|
|
25
|
+
|-------|-------------|---------------|
|
|
26
|
+
| `openspec-explore` | Exploration mode to investigate problems, map architecture, find integration points before implementing. | Pre-analysis |
|
|
27
|
+
| `openspec-new-change` | Creates a new change with step-by-step workflow (proposal → specs → design → tasks). | Structured start |
|
|
28
|
+
| `openspec-ff-change` | Fast-forward: creates all artifacts at once to start implementation quickly. | Quick start |
|
|
29
|
+
| `openspec-continue-change` | Continues an existing change by creating the next artifact in the sequence. | Continue workflow |
|
|
30
|
+
| `openspec-apply-change` | Implements tasks from a change (applies code according to specs and tasks). | Change execution |
|
|
31
|
+
| `openspec-verify-change` | Verifies that implementation matches artifacts (specs, tasks, design). | Validation |
|
|
32
|
+
| `openspec-archive-change` | Archives a completed change by moving it to `openspec/changes/archive/`. | Change closure |
|
|
33
|
+
| `openspec-onboard` | Guided tutorial to learn OpenSpec with a complete example workflow. | Learning |
|
|
34
|
+
| `openspec-sync-specs` | Synchronizes delta specs to main specs (intelligent merge). | Update specs |
|
|
35
|
+
| `openspec-bulk-archive-change` | Archives multiple completed changes at once. | Bulk cleanup |
|
|
36
|
+
|
|
37
|
+
### Documentation and Debugging Skills
|
|
38
|
+
|
|
39
|
+
| Skill | Description | Primary Use |
|
|
40
|
+
|-------|-------------|---------------|
|
|
41
|
+
| `project-index` | Generates structured project documentation: structure analysis, domains, agent guides. | Indexing and context |
|
|
42
|
+
| `systematic-debugging` | Structured debugging in 4 phases: root cause investigation, pattern analysis, hypothesis, implementation. | Problem resolution |
|
|
43
|
+
| `changelog-generator` | Creates automated changelogs from git commits, translating technical to user language. | Version history |
|
|
44
|
+
| `skill-writer` | Guide to create new skills for Claude Code with correct structure and frontmatter. | Create new skills |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 🚀 Workflow: New Project
|
|
49
|
+
|
|
50
|
+
When starting a project **from scratch**, follow this mandatory workflow:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
54
|
+
│ WORKFLOW: NEW PROJECT │
|
|
55
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
56
|
+
|
|
57
|
+
┌─────────────────┐
|
|
58
|
+
│ START │
|
|
59
|
+
└────────┬────────┘
|
|
60
|
+
│
|
|
61
|
+
▼
|
|
62
|
+
┌──────────────────────────────────────────────┐
|
|
63
|
+
│ PHASE 1: FOUNDATIONS (Mandatory) │
|
|
64
|
+
│ │
|
|
65
|
+
│ 1. secure-coding-cybersecurity │
|
|
66
|
+
│ └─ Establish security guidelines │
|
|
67
|
+
│ │
|
|
68
|
+
│ 2. code-maintainability │
|
|
69
|
+
│ └─ Define quality standards │
|
|
70
|
+
│ │
|
|
71
|
+
│ 3. brainstorming │
|
|
72
|
+
│ └─ Architecture and design decisions │
|
|
73
|
+
└────────────────────┬─────────────────────────┘
|
|
74
|
+
│
|
|
75
|
+
▼
|
|
76
|
+
┌──────────────────────────────────────────────┐
|
|
77
|
+
│ PHASE 2: SPECIFICATION (Mandatory) │
|
|
78
|
+
│ │
|
|
79
|
+
│ 4. openspec-new-change │
|
|
80
|
+
│ └─ Create change with proposal │
|
|
81
|
+
│ │
|
|
82
|
+
│ 5. openspec-continue-change │
|
|
83
|
+
│ └─ Create specs, design, tasks │
|
|
84
|
+
│ (or use openspec-ff-change) │
|
|
85
|
+
└────────────────────┬─────────────────────────┘
|
|
86
|
+
│
|
|
87
|
+
▼
|
|
88
|
+
┌──────────────────────────────────────────────┐
|
|
89
|
+
│ PHASE 3: IMPLEMENTATION │
|
|
90
|
+
│ │
|
|
91
|
+
│ 6. openspec-apply-change │
|
|
92
|
+
│ └─ Implement the tasks │
|
|
93
|
+
└────────────────────┬─────────────────────────┘
|
|
94
|
+
│
|
|
95
|
+
▼
|
|
96
|
+
┌──────────────────────────────────────────────┐
|
|
97
|
+
│ PHASE 4: VALIDATION AND CLOSURE │
|
|
98
|
+
│ │
|
|
99
|
+
│ 7. systematic-debugging │
|
|
100
|
+
│ └─ Verify no errors │
|
|
101
|
+
│ │
|
|
102
|
+
│ 8. openspec-verify-change │
|
|
103
|
+
│ └─ Validate against specs │
|
|
104
|
+
│ │
|
|
105
|
+
│ 9. changelog-generator │
|
|
106
|
+
│ └─ Generate in changelogs/by-ai/ │
|
|
107
|
+
│ │
|
|
108
|
+
│ 10. openspec-archive-change │
|
|
109
|
+
│ └─ Archive the change │
|
|
110
|
+
└──────────────────────────────────────────────┘
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Phase Descriptions - New Project
|
|
114
|
+
|
|
115
|
+
| Phase | Skill | Description | Expected Output |
|
|
116
|
+
|------|-------|-------------|-----------------|
|
|
117
|
+
| 1 | `secure-coding-cybersecurity` | Establish security guidelines: input validation, sanitization, injection prevention, secrets handling | `.agents/security-guidelines.md` |
|
|
118
|
+
| 2 | `code-maintainability` | Define conventions: naming, folder structure, design patterns, DRY, testing | `.agents/maintainability-rules.md` |
|
|
119
|
+
| 3 | `brainstorming` | Generate architecture ideas, question approach, explore alternatives | `.agents/architecture-decisions.md` |
|
|
120
|
+
| 4 | `openspec-new-change` | Create change with proposal (why, what changes, capabilities) | `openspec/changes/<name>/proposal.md` |
|
|
121
|
+
| 5 | `openspec-continue-change` | Create specs (WHEN/THEN requirements), design (technical decisions), tasks (checklist) | Complete OpenSpec artifacts |
|
|
122
|
+
| 6 | `openspec-apply-change` | Implement code according to specs and tasks | Functional code |
|
|
123
|
+
| 7 | `systematic-debugging` | Structured debugging: investigate root cause, don't guess | Validation report |
|
|
124
|
+
| 8 | `openspec-verify-change` | Verify completeness, correctness, and coherence | Verification report |
|
|
125
|
+
| 9 | `changelog-generator` | Document changes in user language | `changelogs/by-ai/[date]-[feature].md` |
|
|
126
|
+
| 10 | `openspec-archive-change` | Move change to archive with date | `openspec/changes/archive/YYYY-MM-DD-<name>/` |
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 🔍 Workflow: Existing Project
|
|
131
|
+
|
|
132
|
+
When working on an **already created** project that does NOT have `.md` documentation files:
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
136
|
+
│ WORKFLOW: EXISTING PROJECT (NO DOCS) │
|
|
137
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
138
|
+
|
|
139
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
140
|
+
│ │
|
|
141
|
+
│ ⚠️ CHECK: No documentation .md files exist in │
|
|
142
|
+
│ .agents/ or openspec/ │
|
|
143
|
+
│ │
|
|
144
|
+
└────────────────────────────────────────────────────┬─────────────────────┘
|
|
145
|
+
│
|
|
146
|
+
▼
|
|
147
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
148
|
+
│ │
|
|
149
|
+
│ 🔄 STEP 0: project-index │
|
|
150
|
+
│ Generate complete documentation for existing project │
|
|
151
|
+
│ ├─ Analyze folder structure │
|
|
152
|
+
│ ├─ Identify domains (UI, Backend, DB, etc.) │
|
|
153
|
+
│ ├─ Create specific sub-skills per domain │
|
|
154
|
+
│ └─ Generate agent-guidance files │
|
|
155
|
+
│ │
|
|
156
|
+
│ Output: │
|
|
157
|
+
│ ├─ .agents/project-index.md │
|
|
158
|
+
│ ├─ .agents/agent-<domain>.md (in each folder) │
|
|
159
|
+
│ └─ .claude/skills/project-index-<domain>/SKILL.md │
|
|
160
|
+
│ │
|
|
161
|
+
└─────────────────────────────────────────────────────────────────────────┘
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Post-Indexing
|
|
165
|
+
|
|
166
|
+
Once the project is indexed, continue with the [Changes Workflow](#-workflow-changesiterations).
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## 🔄 Workflow: Changes/Iterations
|
|
171
|
+
|
|
172
|
+
For **each change or new feature** in an already documented project:
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
176
|
+
│ WORKFLOW: CHANGES AND ITERATIONS │
|
|
177
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
178
|
+
|
|
179
|
+
┌─────────────────────────┐
|
|
180
|
+
│ START CHANGE │
|
|
181
|
+
└────────┬────────────────┘
|
|
182
|
+
│
|
|
183
|
+
▼
|
|
184
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
185
|
+
│ 1. openspec-explore │────▶│ 2. brainstorming │
|
|
186
|
+
│ (Explore current │ │ (Based on exploration: │
|
|
187
|
+
│ code and structure) │ │ - Generate ideas │
|
|
188
|
+
└─────────────────────────┘ │ - Suggest improvements │
|
|
189
|
+
│ - Ask key questions to user) │
|
|
190
|
+
└─────────────────┬────────────────────────┘
|
|
191
|
+
│
|
|
192
|
+
▼
|
|
193
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
194
|
+
│ 3. openspec-new │────▶│ 4. openspec-continue / ff │
|
|
195
|
+
│ (Create specification │ │ (Create specs, design, tasks) │
|
|
196
|
+
│ for change/feature) │ └─────────────────┬────────────────────────┘
|
|
197
|
+
└─────────────────────────┘ │
|
|
198
|
+
▼
|
|
199
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
200
|
+
│ 5. openspec-apply │────▶│ 6. systematic-debugging │
|
|
201
|
+
│ (Implement changes │ │ (Verify no errors, │
|
|
202
|
+
│ according to tasks) │ │ validate patterns) │
|
|
203
|
+
└─────────────────────────┘ └─────────────────┬────────────────────────┘
|
|
204
|
+
│
|
|
205
|
+
▼
|
|
206
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
207
|
+
│ 7. openspec-verify │────▶│ 8. changelog-generator │
|
|
208
|
+
│ (Verify against │ │ (Generate change record │
|
|
209
|
+
│ specs and design) │ │ in changelogs/by-ai/) │
|
|
210
|
+
└─────────────────────────┘ └─────────────────┬────────────────────────┘
|
|
211
|
+
│
|
|
212
|
+
▼
|
|
213
|
+
┌─────────────────────────┐ ┌──────────────────────────────────────────┐
|
|
214
|
+
│ 9. openspec-archive │────▶│ 10. openspec-sync-specs (optional) │
|
|
215
|
+
│ (Archive completed │ │ (Sync specs to main) │
|
|
216
|
+
│ change) │ └──────────────────────────────────────────┘
|
|
217
|
+
└─────────────────────────┘
|
|
218
|
+
│
|
|
219
|
+
▼
|
|
220
|
+
┌─────────────────────────────────────────────────────────────────────────┐
|
|
221
|
+
│ │
|
|
222
|
+
│ ✅ CHANGE COMPLETED AND DOCUMENTED │
|
|
223
|
+
│ │
|
|
224
|
+
└─────────────────────────────────────────────────────────────────────────┘
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Phase Descriptions - Changes/Iterations
|
|
228
|
+
|
|
229
|
+
| Phase | Skill | Description | Required Input | Expected Output |
|
|
230
|
+
|------|-------|-------------|-----------------|-----------------|
|
|
231
|
+
| 1 | `openspec-explore` | Analyze current code state, identify dependencies and modification points | Change request context | Impact report in `.agents/exploration-report.md` |
|
|
232
|
+
| 2 | `brainstorming` | Generate ideas based on exploration, suggest alternatives, ask user questions | Exploration report | `.agents/brainstorming-session.md` with decisions |
|
|
233
|
+
| 3 | `openspec-new-change` | Create change container with initial proposal | Brainstorming decisions | `openspec/changes/<name>/proposal.md` |
|
|
234
|
+
| 4 | `openspec-continue-change` or `openspec-ff-change` | Create specs, design, and tasks | Approved proposal | Complete OpenSpec artifacts |
|
|
235
|
+
| 5 | `openspec-apply-change` | Implement tasks as described | Tasks ready | Modified code following specs |
|
|
236
|
+
| 6 | `systematic-debugging` | Validate no errors, verify applied patterns | Modified code | Validation report in `.agents/debug-report.md` |
|
|
237
|
+
| 7 | `openspec-verify-change` | Verify implementation matches specs and design | Artifacts + code | Verification report |
|
|
238
|
+
| 8 | `changelog-generator` | Document change in history | Implemented feature | `changelogs/by-ai/[YYYY-MM-DD]-[feature].md` |
|
|
239
|
+
| 9 | `openspec-archive-change` | Archive completed change | Change ready | `openspec/changes/archive/YYYY-MM-DD-<name>/` |
|
|
240
|
+
| 10 | `openspec-sync-specs` (optional) | Synchronize delta specs to main specs | Delta specs | Main specs updated |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## ✅ Validation Checklist
|
|
245
|
+
|
|
246
|
+
Before considering any task as **completed**, verify:
|
|
247
|
+
|
|
248
|
+
```
|
|
249
|
+
╔═══════════════════════════════════════════════════════════════════════════════════╗
|
|
250
|
+
║ MANDATORY CHECKLIST ║
|
|
251
|
+
╠═══════════════════════════════════════════════════════════════════════════════════╣
|
|
252
|
+
║ ║
|
|
253
|
+
║ □ Security ║
|
|
254
|
+
║ └─ □ secure-coding-cybersecurity executed ║
|
|
255
|
+
║ └─ □ No known vulnerabilities (SQL injection, XSS, etc.) ║
|
|
256
|
+
║ └─ □ Inputs validated and sanitized ║
|
|
257
|
+
║ └─ □ Secrets/keys not hardcoded ║
|
|
258
|
+
║ └─ □ No eval() or dynamic code execution with user input ║
|
|
259
|
+
║ ║
|
|
260
|
+
║ □ Maintainability ║
|
|
261
|
+
║ └─ □ code-maintainability executed ║
|
|
262
|
+
║ └─ □ Code follows project conventions ║
|
|
263
|
+
║ └─ □ Functions/classes have single responsibility ║
|
|
264
|
+
║ └─ □ Descriptive and semantic names ║
|
|
265
|
+
║ └─ □ No duplicate code (DRY principle) ║
|
|
266
|
+
║ └─ □ Documentation explains "why", not "what" ║
|
|
267
|
+
║ ║
|
|
268
|
+
║ □ Error Handling ║
|
|
269
|
+
║ └─ □ error-handling-patterns applied ║
|
|
270
|
+
║ └─ □ All errors handled gracefully ║
|
|
271
|
+
║ └─ □ Edge cases covered (null, empty, boundaries) ║
|
|
272
|
+
║ ║
|
|
273
|
+
║ □ Specification (OpenSpec) ║
|
|
274
|
+
║ └─ □ Change created with proposal, specs, design, tasks ║
|
|
275
|
+
║ └─ □ Implementation matches specification ║
|
|
276
|
+
║ └─ □ All WHEN/THEN scenarios implemented ║
|
|
277
|
+
║ └─ □ Design decisions documented ║
|
|
278
|
+
║ ║
|
|
279
|
+
║ □ Implementation ║
|
|
280
|
+
║ └─ □ All tasks marked complete [- [x]] ║
|
|
281
|
+
║ └─ □ Code tested and functional ║
|
|
282
|
+
║ └─ □ No console.logs or debug code ║
|
|
283
|
+
║ ║
|
|
284
|
+
║ □ Validation ║
|
|
285
|
+
║ └─ □ systematic-debugging executed without critical errors ║
|
|
286
|
+
║ └─ □ openspec-verify-change passed (or reviewed) ║
|
|
287
|
+
║ └─ □ Design patterns correctly applied ║
|
|
288
|
+
║ ║
|
|
289
|
+
║ □ Documentation ║
|
|
290
|
+
║ └─ □ Project index updated if structure changed ║
|
|
291
|
+
║ └─ □ Changelog generated in changelogs/by-ai/ ║
|
|
292
|
+
║ └─ □ README updated if necessary ║
|
|
293
|
+
║ ║
|
|
294
|
+
║ □ Closure ║
|
|
295
|
+
║ └─ □ Change archived with openspec-archive-change ║
|
|
296
|
+
║ └─ □ Delta specs synchronized (if applicable) ║
|
|
297
|
+
║ ║
|
|
298
|
+
╚═══════════════════════════════════════════════════════════════════════════════════╝
|