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
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
The MIT License (MIT)
|
|
2
2
|
|
|
3
|
-
Copyright © 2026
|
|
3
|
+
Copyright © 2026 AC-Framework Contributors
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
6
6
|
|
|
@@ -1,47 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
```
|
|
4
|
-
╔══════════════════════════════════════════════════════════════════════════════════════════╗
|
|
5
|
-
║ ║
|
|
6
|
-
║ █████╗ ██████╗ ███████╗███╗ ██╗████████╗███████╗ ║
|
|
7
|
-
║ ██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝██╔════╝ ║
|
|
8
|
-
║ ███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║ ███████╗ ║
|
|
9
|
-
║ ██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║ ╚════██║ ║
|
|
10
|
-
║ ██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║ ███████║ ║
|
|
11
|
-
║ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚══════╝ ║
|
|
12
|
-
║ ║
|
|
13
|
-
║ Intelligent Software Development Framework ║
|
|
14
|
-
║ ║
|
|
15
|
-
╚══════════════════════════════════════════════════════════════════════════════════════════╝
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## 📋 Index
|
|
21
|
-
|
|
22
|
-
1. [Framework Philosophy](#-framework-philosophy)
|
|
23
|
-
2. [Available Skills](#-available-skills)
|
|
24
|
-
3. [Workflow: New Project](#-workflow-new-project)
|
|
25
|
-
4. [Workflow: Existing Project](#-workflow-existing-project)
|
|
26
|
-
5. [Workflow: Changes/Iterations](#-workflow-changesiterations)
|
|
27
|
-
6. [Validation Checklist](#-validation-checklist)
|
|
28
|
-
7. [Directory Structure](#-directory-structure)
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## 🎯 Framework Philosophy
|
|
33
|
-
|
|
34
|
-
This framework is designed to ensure all AI-developed projects follow:
|
|
35
|
-
|
|
36
|
-
- ✅ **Best coding practices** from the start
|
|
37
|
-
- ✅ **Maintainable** and scalable architecture
|
|
38
|
-
- ✅ **Complete and up-to-date** documentation
|
|
39
|
-
- ✅ **Clear specifications** through OpenSpec
|
|
40
|
-
- ✅ **Systematic debugging** of problems
|
|
41
|
-
- ✅ **Automated change history**
|
|
42
|
-
|
|
43
|
-
> **Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
44
|
-
|
|
1
|
+
**Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
45
2
|
---
|
|
46
3
|
|
|
47
4
|
## 🛠️ Available Skills
|
|
@@ -338,127 +295,4 @@ Before considering any task as **completed**, verify:
|
|
|
338
295
|
║ └─ □ Change archived with openspec-archive-change ║
|
|
339
296
|
║ └─ □ Delta specs synchronized (if applicable) ║
|
|
340
297
|
║ ║
|
|
341
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
---
|
|
345
|
-
|
|
346
|
-
## 📁 Directory Structure
|
|
347
|
-
|
|
348
|
-
```
|
|
349
|
-
project/
|
|
350
|
-
│
|
|
351
|
-
├── 📂 .agents/ # AI-generated documentation
|
|
352
|
-
│ ├── security-guidelines.md # Security practices
|
|
353
|
-
│ ├── maintainability-rules.md # Maintainability rules
|
|
354
|
-
│ ├── architecture-decisions.md # Architecture decisions
|
|
355
|
-
│ ├── project-index.md # Complete project index
|
|
356
|
-
│ ├── exploration-report.md # Exploration reports
|
|
357
|
-
│ ├── brainstorming-session.md # Brainstorming sessions
|
|
358
|
-
│ ├── debug-report.md # Debugging reports
|
|
359
|
-
│ └── agent-<domain>.md # Per-domain guides (e.g., agent-ui.md)
|
|
360
|
-
│
|
|
361
|
-
├── 📂 .claude/ # Project-specific skills
|
|
362
|
-
│ └── skills/
|
|
363
|
-
│ └── project-index-<domain>/
|
|
364
|
-
│ └── SKILL.md # Domain-specific skills
|
|
365
|
-
│
|
|
366
|
-
├── 📂 .openspec/ # Formal specifications (OpenSpec)
|
|
367
|
-
│ ├── specs/ # Main specifications
|
|
368
|
-
│ │ └── <capability>/
|
|
369
|
-
│ │ └── spec.md
|
|
370
|
-
│ └── changes/ # Active changes
|
|
371
|
-
│ ├── <change-name>/
|
|
372
|
-
│ │ ├── proposal.md # Why and what changes
|
|
373
|
-
│ │ ├── design.md # How to build it
|
|
374
|
-
│ │ ├── tasks.md # Implementation checklist
|
|
375
|
-
│ │ └── specs/ # Delta specs
|
|
376
|
-
│ │ └── <capability>/
|
|
377
|
-
│ │ └── spec.md
|
|
378
|
-
│ └── archive/ # Completed changes
|
|
379
|
-
│ └── YYYY-MM-DD-<name>/
|
|
380
|
-
│
|
|
381
|
-
├── 📂 changelogs/ # Change history
|
|
382
|
-
│ └── by-ai/ # AI-generated changelogs
|
|
383
|
-
│ └── YYYY-MM-DD-feature.md
|
|
384
|
-
│
|
|
385
|
-
└── [project source code]
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
## 🎓 Quick Usage
|
|
391
|
-
|
|
392
|
-
### To start a new project:
|
|
393
|
-
```
|
|
394
|
-
1. Execute: secure-coding-cybersecurity
|
|
395
|
-
2. Execute: code-maintainability
|
|
396
|
-
3. Execute: brainstorming
|
|
397
|
-
4. Execute: openspec-new-change (or openspec-ff-change for quick mode)
|
|
398
|
-
5. Execute: openspec-continue-change (create specs, design, tasks)
|
|
399
|
-
6. Execute: openspec-apply-change
|
|
400
|
-
7. Execute: systematic-debugging
|
|
401
|
-
8. Execute: openspec-verify-change
|
|
402
|
-
9. Execute: changelog-generator
|
|
403
|
-
10. Execute: openspec-archive-change
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
### To modify an existing project:
|
|
407
|
-
```
|
|
408
|
-
1. Check if documentation exists (.agents/, openspec/)
|
|
409
|
-
└─ If NOT exists → Execute: project-index
|
|
410
|
-
|
|
411
|
-
2. Execute: openspec-explore
|
|
412
|
-
3. Execute: brainstorming
|
|
413
|
-
4. Execute: openspec-new-change (create change)
|
|
414
|
-
5. Execute: openspec-continue-change (complete artifacts)
|
|
415
|
-
6. Execute: openspec-apply-change (implement)
|
|
416
|
-
7. Execute: systematic-debugging (validate)
|
|
417
|
-
8. Execute: openspec-verify-change (verify against specs)
|
|
418
|
-
9. Execute: changelog-generator
|
|
419
|
-
10. Execute: openspec-archive-change
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
### Quick OpenSpec commands:
|
|
423
|
-
```
|
|
424
|
-
/opsx:explore - Explore before implementing
|
|
425
|
-
/opsx:new <name> - Create new change step by step
|
|
426
|
-
/opsx:ff <name> - Fast-forward (create all quickly)
|
|
427
|
-
/opsx:continue - Continue existing change
|
|
428
|
-
/opsx:apply - Implement tasks
|
|
429
|
-
/opsx:verify - Verify implementation
|
|
430
|
-
/opsx:archive - Archive completed change
|
|
431
|
-
/opsx:onboard - OpenSpec tutorial
|
|
432
|
-
```
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
## 📌 Important Notes
|
|
437
|
-
|
|
438
|
-
> **⚠️ NEVER skip workflow steps.** Each skill exists to ensure quality.
|
|
439
|
-
|
|
440
|
-
> **📝 Documentation = Code.** If not documented in OpenSpec, it's not done.
|
|
441
|
-
|
|
442
|
-
> **🔒 Security first.** Always execute secure-coding-cybersecurity before any implementation.
|
|
443
|
-
|
|
444
|
-
> **🧠 Brainstorming is mandatory.** Never implement without questioning the approach first.
|
|
445
|
-
|
|
446
|
-
> **✅ Validation before commit.** Always execute systematic-debugging and openspec-verify before finishing.
|
|
447
|
-
|
|
448
|
-
> **📦 One change = One feature.** Don't mix multiple features in a single change.
|
|
449
|
-
|
|
450
|
-
> **🔄 Sync specs.** After archiving, synchronize delta specs to main specs.
|
|
451
|
-
|
|
452
|
-
---
|
|
453
|
-
|
|
454
|
-
```
|
|
455
|
-
╔═══════════════════════════════════════════════════════════════════════════════════╗
|
|
456
|
-
║ ║
|
|
457
|
-
║ "Well-specified code is well-implemented code" ║
|
|
458
|
-
║ ║
|
|
459
|
-
║ Framework AGENTS.md v2.0 ║
|
|
460
|
-
║ ║
|
|
461
|
-
║ 22 Skills Available | OpenSpec Workflow Integrated ║
|
|
462
|
-
║ ║
|
|
463
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
464
|
-
```
|
|
298
|
+
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
@@ -1,47 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
```
|
|
4
|
-
╔══════════════════════════════════════════════════════════════════════════════════════════╗
|
|
5
|
-
║ ║
|
|
6
|
-
║ █████╗ ██████╗ ███████╗███╗ ██╗████████╗███████╗ ║
|
|
7
|
-
║ ██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝██╔════╝ ║
|
|
8
|
-
║ ███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║ ███████╗ ║
|
|
9
|
-
║ ██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║ ╚════██║ ║
|
|
10
|
-
║ ██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║ ███████║ ║
|
|
11
|
-
║ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚══════╝ ║
|
|
12
|
-
║ ║
|
|
13
|
-
║ Intelligent Software Development Framework ║
|
|
14
|
-
║ ║
|
|
15
|
-
╚══════════════════════════════════════════════════════════════════════════════════════════╝
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## 📋 Index
|
|
21
|
-
|
|
22
|
-
1. [Framework Philosophy](#-framework-philosophy)
|
|
23
|
-
2. [Available Skills](#-available-skills)
|
|
24
|
-
3. [Workflow: New Project](#-workflow-new-project)
|
|
25
|
-
4. [Workflow: Existing Project](#-workflow-existing-project)
|
|
26
|
-
5. [Workflow: Changes/Iterations](#-workflow-changesiterations)
|
|
27
|
-
6. [Validation Checklist](#-validation-checklist)
|
|
28
|
-
7. [Directory Structure](#-directory-structure)
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## 🎯 Framework Philosophy
|
|
33
|
-
|
|
34
|
-
This framework is designed to ensure all AI-developed projects follow:
|
|
35
|
-
|
|
36
|
-
- ✅ **Best coding practices** from the start
|
|
37
|
-
- ✅ **Maintainable** and scalable architecture
|
|
38
|
-
- ✅ **Complete and up-to-date** documentation
|
|
39
|
-
- ✅ **Clear specifications** through OpenSpec
|
|
40
|
-
- ✅ **Systematic debugging** of problems
|
|
41
|
-
- ✅ **Automated change history**
|
|
42
|
-
|
|
43
|
-
> **Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
44
|
-
|
|
1
|
+
**Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
45
2
|
---
|
|
46
3
|
|
|
47
4
|
## 🛠️ Available Skills
|
|
@@ -338,127 +295,4 @@ Before considering any task as **completed**, verify:
|
|
|
338
295
|
║ └─ □ Change archived with openspec-archive-change ║
|
|
339
296
|
║ └─ □ Delta specs synchronized (if applicable) ║
|
|
340
297
|
║ ║
|
|
341
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
---
|
|
345
|
-
|
|
346
|
-
## 📁 Directory Structure
|
|
347
|
-
|
|
348
|
-
```
|
|
349
|
-
project/
|
|
350
|
-
│
|
|
351
|
-
├── 📂 .agents/ # AI-generated documentation
|
|
352
|
-
│ ├── security-guidelines.md # Security practices
|
|
353
|
-
│ ├── maintainability-rules.md # Maintainability rules
|
|
354
|
-
│ ├── architecture-decisions.md # Architecture decisions
|
|
355
|
-
│ ├── project-index.md # Complete project index
|
|
356
|
-
│ ├── exploration-report.md # Exploration reports
|
|
357
|
-
│ ├── brainstorming-session.md # Brainstorming sessions
|
|
358
|
-
│ ├── debug-report.md # Debugging reports
|
|
359
|
-
│ └── agent-<domain>.md # Per-domain guides (e.g., agent-ui.md)
|
|
360
|
-
│
|
|
361
|
-
├── 📂 .claude/ # Project-specific skills
|
|
362
|
-
│ └── skills/
|
|
363
|
-
│ └── project-index-<domain>/
|
|
364
|
-
│ └── SKILL.md # Domain-specific skills
|
|
365
|
-
│
|
|
366
|
-
├── 📂 .openspec/ # Formal specifications (OpenSpec)
|
|
367
|
-
│ ├── specs/ # Main specifications
|
|
368
|
-
│ │ └── <capability>/
|
|
369
|
-
│ │ └── spec.md
|
|
370
|
-
│ └── changes/ # Active changes
|
|
371
|
-
│ ├── <change-name>/
|
|
372
|
-
│ │ ├── proposal.md # Why and what changes
|
|
373
|
-
│ │ ├── design.md # How to build it
|
|
374
|
-
│ │ ├── tasks.md # Implementation checklist
|
|
375
|
-
│ │ └── specs/ # Delta specs
|
|
376
|
-
│ │ └── <capability>/
|
|
377
|
-
│ │ └── spec.md
|
|
378
|
-
│ └── archive/ # Completed changes
|
|
379
|
-
│ └── YYYY-MM-DD-<name>/
|
|
380
|
-
│
|
|
381
|
-
├── 📂 changelogs/ # Change history
|
|
382
|
-
│ └── by-ai/ # AI-generated changelogs
|
|
383
|
-
│ └── YYYY-MM-DD-feature.md
|
|
384
|
-
│
|
|
385
|
-
└── [project source code]
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
## 🎓 Quick Usage
|
|
391
|
-
|
|
392
|
-
### To start a new project:
|
|
393
|
-
```
|
|
394
|
-
1. Execute: secure-coding-cybersecurity
|
|
395
|
-
2. Execute: code-maintainability
|
|
396
|
-
3. Execute: brainstorming
|
|
397
|
-
4. Execute: openspec-new-change (or openspec-ff-change for quick mode)
|
|
398
|
-
5. Execute: openspec-continue-change (create specs, design, tasks)
|
|
399
|
-
6. Execute: openspec-apply-change
|
|
400
|
-
7. Execute: systematic-debugging
|
|
401
|
-
8. Execute: openspec-verify-change
|
|
402
|
-
9. Execute: changelog-generator
|
|
403
|
-
10. Execute: openspec-archive-change
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
### To modify an existing project:
|
|
407
|
-
```
|
|
408
|
-
1. Check if documentation exists (.agents/, openspec/)
|
|
409
|
-
└─ If NOT exists → Execute: project-index
|
|
410
|
-
|
|
411
|
-
2. Execute: openspec-explore
|
|
412
|
-
3. Execute: brainstorming
|
|
413
|
-
4. Execute: openspec-new-change (create change)
|
|
414
|
-
5. Execute: openspec-continue-change (complete artifacts)
|
|
415
|
-
6. Execute: openspec-apply-change (implement)
|
|
416
|
-
7. Execute: systematic-debugging (validate)
|
|
417
|
-
8. Execute: openspec-verify-change (verify against specs)
|
|
418
|
-
9. Execute: changelog-generator
|
|
419
|
-
10. Execute: openspec-archive-change
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
### Quick OpenSpec commands:
|
|
423
|
-
```
|
|
424
|
-
/opsx:explore - Explore before implementing
|
|
425
|
-
/opsx:new <name> - Create new change step by step
|
|
426
|
-
/opsx:ff <name> - Fast-forward (create all quickly)
|
|
427
|
-
/opsx:continue - Continue existing change
|
|
428
|
-
/opsx:apply - Implement tasks
|
|
429
|
-
/opsx:verify - Verify implementation
|
|
430
|
-
/opsx:archive - Archive completed change
|
|
431
|
-
/opsx:onboard - OpenSpec tutorial
|
|
432
|
-
```
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
## 📌 Important Notes
|
|
437
|
-
|
|
438
|
-
> **⚠️ NEVER skip workflow steps.** Each skill exists to ensure quality.
|
|
439
|
-
|
|
440
|
-
> **📝 Documentation = Code.** If not documented in OpenSpec, it's not done.
|
|
441
|
-
|
|
442
|
-
> **🔒 Security first.** Always execute secure-coding-cybersecurity before any implementation.
|
|
443
|
-
|
|
444
|
-
> **🧠 Brainstorming is mandatory.** Never implement without questioning the approach first.
|
|
445
|
-
|
|
446
|
-
> **✅ Validation before commit.** Always execute systematic-debugging and openspec-verify before finishing.
|
|
447
|
-
|
|
448
|
-
> **📦 One change = One feature.** Don't mix multiple features in a single change.
|
|
449
|
-
|
|
450
|
-
> **🔄 Sync specs.** After archiving, synchronize delta specs to main specs.
|
|
451
|
-
|
|
452
|
-
---
|
|
453
|
-
|
|
454
|
-
```
|
|
455
|
-
╔═══════════════════════════════════════════════════════════════════════════════════╗
|
|
456
|
-
║ ║
|
|
457
|
-
║ "Well-specified code is well-implemented code" ║
|
|
458
|
-
║ ║
|
|
459
|
-
║ Framework AGENTS.md v2.0 ║
|
|
460
|
-
║ ║
|
|
461
|
-
║ 22 Skills Available | OpenSpec Workflow Integrated ║
|
|
462
|
-
║ ║
|
|
463
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
464
|
-
```
|
|
298
|
+
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
@@ -1,47 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
```
|
|
4
|
-
╔══════════════════════════════════════════════════════════════════════════════════════════╗
|
|
5
|
-
║ ║
|
|
6
|
-
║ █████╗ ██████╗ ███████╗███╗ ██╗████████╗███████╗ ║
|
|
7
|
-
║ ██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝██╔════╝ ║
|
|
8
|
-
║ ███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║ ███████╗ ║
|
|
9
|
-
║ ██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║ ╚════██║ ║
|
|
10
|
-
║ ██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║ ███████║ ║
|
|
11
|
-
║ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚══════╝ ║
|
|
12
|
-
║ ║
|
|
13
|
-
║ Intelligent Software Development Framework ║
|
|
14
|
-
║ ║
|
|
15
|
-
╚══════════════════════════════════════════════════════════════════════════════════════════╝
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## 📋 Index
|
|
21
|
-
|
|
22
|
-
1. [Framework Philosophy](#-framework-philosophy)
|
|
23
|
-
2. [Available Skills](#-available-skills)
|
|
24
|
-
3. [Workflow: New Project](#-workflow-new-project)
|
|
25
|
-
4. [Workflow: Existing Project](#-workflow-existing-project)
|
|
26
|
-
5. [Workflow: Changes/Iterations](#-workflow-changesiterations)
|
|
27
|
-
6. [Validation Checklist](#-validation-checklist)
|
|
28
|
-
7. [Directory Structure](#-directory-structure)
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## 🎯 Framework Philosophy
|
|
33
|
-
|
|
34
|
-
This framework is designed to ensure all AI-developed projects follow:
|
|
35
|
-
|
|
36
|
-
- ✅ **Best coding practices** from the start
|
|
37
|
-
- ✅ **Maintainable** and scalable architecture
|
|
38
|
-
- ✅ **Complete and up-to-date** documentation
|
|
39
|
-
- ✅ **Clear specifications** through OpenSpec
|
|
40
|
-
- ✅ **Systematic debugging** of problems
|
|
41
|
-
- ✅ **Automated change history**
|
|
42
|
-
|
|
43
|
-
> **Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
44
|
-
|
|
1
|
+
**Fundamental Principle**: *"Quality over speed. Documentation before code. Planning before execution."*
|
|
45
2
|
---
|
|
46
3
|
|
|
47
4
|
## 🛠️ Available Skills
|
|
@@ -338,127 +295,4 @@ Before considering any task as **completed**, verify:
|
|
|
338
295
|
║ └─ □ Change archived with openspec-archive-change ║
|
|
339
296
|
║ └─ □ Delta specs synchronized (if applicable) ║
|
|
340
297
|
║ ║
|
|
341
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
---
|
|
345
|
-
|
|
346
|
-
## 📁 Directory Structure
|
|
347
|
-
|
|
348
|
-
```
|
|
349
|
-
project/
|
|
350
|
-
│
|
|
351
|
-
├── 📂 .agents/ # AI-generated documentation
|
|
352
|
-
│ ├── security-guidelines.md # Security practices
|
|
353
|
-
│ ├── maintainability-rules.md # Maintainability rules
|
|
354
|
-
│ ├── architecture-decisions.md # Architecture decisions
|
|
355
|
-
│ ├── project-index.md # Complete project index
|
|
356
|
-
│ ├── exploration-report.md # Exploration reports
|
|
357
|
-
│ ├── brainstorming-session.md # Brainstorming sessions
|
|
358
|
-
│ ├── debug-report.md # Debugging reports
|
|
359
|
-
│ └── agent-<domain>.md # Per-domain guides (e.g., agent-ui.md)
|
|
360
|
-
│
|
|
361
|
-
├── 📂 .claude/ # Project-specific skills
|
|
362
|
-
│ └── skills/
|
|
363
|
-
│ └── project-index-<domain>/
|
|
364
|
-
│ └── SKILL.md # Domain-specific skills
|
|
365
|
-
│
|
|
366
|
-
├── 📂 .openspec/ # Formal specifications (OpenSpec)
|
|
367
|
-
│ ├── specs/ # Main specifications
|
|
368
|
-
│ │ └── <capability>/
|
|
369
|
-
│ │ └── spec.md
|
|
370
|
-
│ └── changes/ # Active changes
|
|
371
|
-
│ ├── <change-name>/
|
|
372
|
-
│ │ ├── proposal.md # Why and what changes
|
|
373
|
-
│ │ ├── design.md # How to build it
|
|
374
|
-
│ │ ├── tasks.md # Implementation checklist
|
|
375
|
-
│ │ └── specs/ # Delta specs
|
|
376
|
-
│ │ └── <capability>/
|
|
377
|
-
│ │ └── spec.md
|
|
378
|
-
│ └── archive/ # Completed changes
|
|
379
|
-
│ └── YYYY-MM-DD-<name>/
|
|
380
|
-
│
|
|
381
|
-
├── 📂 changelogs/ # Change history
|
|
382
|
-
│ └── by-ai/ # AI-generated changelogs
|
|
383
|
-
│ └── YYYY-MM-DD-feature.md
|
|
384
|
-
│
|
|
385
|
-
└── [project source code]
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
## 🎓 Quick Usage
|
|
391
|
-
|
|
392
|
-
### To start a new project:
|
|
393
|
-
```
|
|
394
|
-
1. Execute: secure-coding-cybersecurity
|
|
395
|
-
2. Execute: code-maintainability
|
|
396
|
-
3. Execute: brainstorming
|
|
397
|
-
4. Execute: openspec-new-change (or openspec-ff-change for quick mode)
|
|
398
|
-
5. Execute: openspec-continue-change (create specs, design, tasks)
|
|
399
|
-
6. Execute: openspec-apply-change
|
|
400
|
-
7. Execute: systematic-debugging
|
|
401
|
-
8. Execute: openspec-verify-change
|
|
402
|
-
9. Execute: changelog-generator
|
|
403
|
-
10. Execute: openspec-archive-change
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
### To modify an existing project:
|
|
407
|
-
```
|
|
408
|
-
1. Check if documentation exists (.agents/, openspec/)
|
|
409
|
-
└─ If NOT exists → Execute: project-index
|
|
410
|
-
|
|
411
|
-
2. Execute: openspec-explore
|
|
412
|
-
3. Execute: brainstorming
|
|
413
|
-
4. Execute: openspec-new-change (create change)
|
|
414
|
-
5. Execute: openspec-continue-change (complete artifacts)
|
|
415
|
-
6. Execute: openspec-apply-change (implement)
|
|
416
|
-
7. Execute: systematic-debugging (validate)
|
|
417
|
-
8. Execute: openspec-verify-change (verify against specs)
|
|
418
|
-
9. Execute: changelog-generator
|
|
419
|
-
10. Execute: openspec-archive-change
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
### Quick OpenSpec commands:
|
|
423
|
-
```
|
|
424
|
-
/opsx:explore - Explore before implementing
|
|
425
|
-
/opsx:new <name> - Create new change step by step
|
|
426
|
-
/opsx:ff <name> - Fast-forward (create all quickly)
|
|
427
|
-
/opsx:continue - Continue existing change
|
|
428
|
-
/opsx:apply - Implement tasks
|
|
429
|
-
/opsx:verify - Verify implementation
|
|
430
|
-
/opsx:archive - Archive completed change
|
|
431
|
-
/opsx:onboard - OpenSpec tutorial
|
|
432
|
-
```
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
## 📌 Important Notes
|
|
437
|
-
|
|
438
|
-
> **⚠️ NEVER skip workflow steps.** Each skill exists to ensure quality.
|
|
439
|
-
|
|
440
|
-
> **📝 Documentation = Code.** If not documented in OpenSpec, it's not done.
|
|
441
|
-
|
|
442
|
-
> **🔒 Security first.** Always execute secure-coding-cybersecurity before any implementation.
|
|
443
|
-
|
|
444
|
-
> **🧠 Brainstorming is mandatory.** Never implement without questioning the approach first.
|
|
445
|
-
|
|
446
|
-
> **✅ Validation before commit.** Always execute systematic-debugging and openspec-verify before finishing.
|
|
447
|
-
|
|
448
|
-
> **📦 One change = One feature.** Don't mix multiple features in a single change.
|
|
449
|
-
|
|
450
|
-
> **🔄 Sync specs.** After archiving, synchronize delta specs to main specs.
|
|
451
|
-
|
|
452
|
-
---
|
|
453
|
-
|
|
454
|
-
```
|
|
455
|
-
╔═══════════════════════════════════════════════════════════════════════════════════╗
|
|
456
|
-
║ ║
|
|
457
|
-
║ "Well-specified code is well-implemented code" ║
|
|
458
|
-
║ ║
|
|
459
|
-
║ Framework AGENTS.md v2.0 ║
|
|
460
|
-
║ ║
|
|
461
|
-
║ 22 Skills Available | OpenSpec Workflow Integrated ║
|
|
462
|
-
║ ║
|
|
463
|
-
╚═══════════════════════════════════════════════════════════════════════════════════╝
|
|
464
|
-
```
|
|
298
|
+
╚═══════════════════════════════════════════════════════════════════════════════════╝
|