moai-adk 0.4.4__py3-none-any.whl → 0.4.7__py3-none-any.whl
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.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/__init__.py +1 -1
- moai_adk/core/project/initializer.py +12 -5
- moai_adk/templates/.claude/agents/alfred/skill-factory.md +829 -0
- moai_adk/templates/.claude/skills/moai-alfred-code-reviewer/SKILL.md +78 -77
- moai_adk/templates/.claude/skills/moai-alfred-code-reviewer/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-code-reviewer/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-debugger-pro/SKILL.md +87 -77
- moai_adk/templates/.claude/skills/moai-alfred-debugger-pro/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-debugger-pro/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/SKILL.md +76 -66
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-ears-authoring/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/SKILL.md +86 -59
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-git-workflow/reference.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/SKILL.md +87 -73
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-language-detection/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-performance-optimizer/SKILL.md +87 -79
- moai_adk/templates/.claude/skills/moai-alfred-performance-optimizer/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-performance-optimizer/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-refactoring-coach/SKILL.md +87 -71
- moai_adk/templates/.claude/skills/moai-alfred-refactoring-coach/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-refactoring-coach/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/SKILL.md +78 -62
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-spec-metadata-validation/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/SKILL.md +78 -55
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-tag-scanning/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/SKILL.md +78 -64
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-alfred-trust-validation/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-alfred-tui-survey/SKILL.md +604 -56
- moai_adk/templates/.claude/skills/moai-alfred-tui-survey/examples.md +974 -44
- moai_adk/templates/.claude/skills/moai-alfred-tui-survey/reference.md +801 -0
- moai_adk/templates/.claude/skills/moai-claude-code/SKILL.md +88 -61
- moai_adk/templates/.claude/skills/moai-claude-code/examples.md +16 -500
- moai_adk/templates/.claude/skills/moai-claude-code/reference.md +15 -420
- moai_adk/templates/.claude/skills/moai-domain-backend/SKILL.md +234 -43
- moai_adk/templates/.claude/skills/moai-domain-backend/examples.md +1633 -0
- moai_adk/templates/.claude/skills/moai-domain-backend/reference.md +660 -0
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/SKILL.md +97 -69
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-cli-tool/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-data-science/SKILL.md +97 -72
- moai_adk/templates/.claude/skills/moai-domain-data-science/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-data-science/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-database/SKILL.md +97 -74
- moai_adk/templates/.claude/skills/moai-domain-database/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-database/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-devops/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-domain-devops/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-devops/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/SKILL.md +98 -73
- moai_adk/templates/.claude/skills/moai-domain-frontend/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-domain-ml/SKILL.md +97 -73
- moai_adk/templates/.claude/skills/moai-domain-ml/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-ml/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/SKILL.md +97 -67
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-mobile-app/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-security/SKILL.md +97 -79
- moai_adk/templates/.claude/skills/moai-domain-security/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-security/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-domain-web-api/SKILL.md +97 -71
- moai_adk/templates/.claude/skills/moai-domain-web-api/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-domain-web-api/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-essentials-debug/SKILL.md +656 -60
- moai_adk/templates/.claude/skills/moai-essentials-debug/examples.md +1107 -0
- moai_adk/templates/.claude/skills/moai-essentials-debug/reference.md +1533 -0
- moai_adk/templates/.claude/skills/moai-essentials-perf/SKILL.md +87 -78
- moai_adk/templates/.claude/skills/moai-essentials-perf/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-perf/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-essentials-refactor/SKILL.md +87 -70
- moai_adk/templates/.claude/skills/moai-essentials-refactor/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-refactor/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-essentials-review/SKILL.md +87 -86
- moai_adk/templates/.claude/skills/moai-essentials-review/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-essentials-review/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-ears/SKILL.md +77 -62
- moai_adk/templates/.claude/skills/moai-foundation-ears/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-ears/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-git/SKILL.md +88 -56
- moai_adk/templates/.claude/skills/moai-foundation-git/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-git/reference.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-langs/SKILL.md +90 -71
- moai_adk/templates/.claude/skills/moai-foundation-langs/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-langs/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-specs/SKILL.md +78 -58
- moai_adk/templates/.claude/skills/moai-foundation-specs/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-specs/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-tags/SKILL.md +78 -51
- moai_adk/templates/.claude/skills/moai-foundation-tags/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-foundation-tags/reference.md +28 -0
- moai_adk/templates/.claude/skills/moai-foundation-trust/SKILL.md +253 -32
- moai_adk/templates/.claude/skills/moai-foundation-trust/examples.md +0 -0
- moai_adk/templates/.claude/skills/moai-foundation-trust/reference.md +1099 -0
- moai_adk/templates/.claude/skills/moai-lang-c/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-lang-c/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-c/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-clojure/SKILL.md +97 -74
- moai_adk/templates/.claude/skills/moai-lang-clojure/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-clojure/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-cpp/SKILL.md +98 -76
- moai_adk/templates/.claude/skills/moai-lang-cpp/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-cpp/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-csharp/SKILL.md +97 -74
- moai_adk/templates/.claude/skills/moai-lang-csharp/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-csharp/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-dart/SKILL.md +86 -61
- moai_adk/templates/.claude/skills/moai-lang-dart/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-dart/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-elixir/SKILL.md +98 -73
- moai_adk/templates/.claude/skills/moai-lang-elixir/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-elixir/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-go/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-lang-go/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-go/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-haskell/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-lang-haskell/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-haskell/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-java/SKILL.md +87 -61
- moai_adk/templates/.claude/skills/moai-lang-java/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-java/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-javascript/SKILL.md +88 -59
- moai_adk/templates/.claude/skills/moai-lang-javascript/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-javascript/reference.md +32 -0
- moai_adk/templates/.claude/skills/moai-lang-julia/SKILL.md +86 -61
- moai_adk/templates/.claude/skills/moai-lang-julia/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-julia/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-kotlin/SKILL.md +98 -73
- moai_adk/templates/.claude/skills/moai-lang-kotlin/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-kotlin/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-lua/SKILL.md +86 -61
- moai_adk/templates/.claude/skills/moai-lang-lua/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-lua/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-php/SKILL.md +86 -61
- moai_adk/templates/.claude/skills/moai-lang-php/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-php/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-python/SKILL.md +388 -53
- moai_adk/templates/.claude/skills/moai-lang-python/examples.md +624 -0
- moai_adk/templates/.claude/skills/moai-lang-python/reference.md +316 -0
- moai_adk/templates/.claude/skills/moai-lang-r/SKILL.md +97 -73
- moai_adk/templates/.claude/skills/moai-lang-r/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-r/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-ruby/SKILL.md +98 -73
- moai_adk/templates/.claude/skills/moai-lang-ruby/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-ruby/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-rust/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-lang-rust/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-rust/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-scala/SKILL.md +97 -74
- moai_adk/templates/.claude/skills/moai-lang-scala/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-scala/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-shell/SKILL.md +97 -74
- moai_adk/templates/.claude/skills/moai-lang-shell/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-shell/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-sql/SKILL.md +98 -74
- moai_adk/templates/.claude/skills/moai-lang-sql/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-sql/reference.md +31 -0
- moai_adk/templates/.claude/skills/moai-lang-swift/SKILL.md +97 -73
- moai_adk/templates/.claude/skills/moai-lang-swift/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-swift/reference.md +30 -0
- moai_adk/templates/.claude/skills/moai-lang-typescript/SKILL.md +90 -59
- moai_adk/templates/.claude/skills/moai-lang-typescript/examples.md +29 -0
- moai_adk/templates/.claude/skills/moai-lang-typescript/reference.md +34 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/CHECKLIST.md +482 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/EXAMPLES.md +52 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/INTERACTIVE-DISCOVERY.md +524 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/METADATA.md +477 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL-UPDATE-ADVISOR.md +577 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL.md +560 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/STRUCTURE.md +583 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/WEB-RESEARCH.md +526 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/reference.md +69 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/scripts/generate-structure.sh +328 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/scripts/validate-skill.sh +312 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/SKILL_TEMPLATE.md +245 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/examples-template.md +285 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/reference-template.md +278 -0
- moai_adk/templates/.claude/skills/moai-skill-factory/templates/scripts-template.sh +303 -0
- moai_adk/templates/CLAUDE.md +43 -11
- moai_adk-0.4.7.dist-info/METADATA +1162 -0
- moai_adk-0.4.7.dist-info/RECORD +275 -0
- moai_adk-0.4.4.dist-info/METADATA +0 -369
- moai_adk-0.4.4.dist-info/RECORD +0 -152
- {moai_adk-0.4.4.dist-info → moai_adk-0.4.7.dist-info}/WHEEL +0 -0
- {moai_adk-0.4.4.dist-info → moai_adk-0.4.7.dist-info}/entry_points.txt +0 -0
- {moai_adk-0.4.4.dist-info → moai_adk-0.4.7.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,1162 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: moai-adk
|
|
3
|
+
Version: 0.4.7
|
|
4
|
+
Summary: MoAI Agentic Development Kit - SPEC-First TDD with Alfred SuperAgent & Complete Skills v2.0
|
|
5
|
+
Project-URL: Homepage, https://github.com/modu-ai/moai-adk
|
|
6
|
+
Project-URL: Repository, https://github.com/modu-ai/moai-adk
|
|
7
|
+
Project-URL: Issues, https://github.com/modu-ai/moai-adk/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/modu-ai/moai-adk/releases
|
|
9
|
+
Author-email: MoAI Team <support@moduai.kr>
|
|
10
|
+
License: MIT
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: agentic,ai,alfred,claude,development,spec-first,tdd,toolkit
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
19
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
20
|
+
Classifier: Topic :: Software Development :: Testing
|
|
21
|
+
Requires-Python: >=3.13
|
|
22
|
+
Requires-Dist: click>=8.1.0
|
|
23
|
+
Requires-Dist: gitpython>=3.1.45
|
|
24
|
+
Requires-Dist: packaging>=21.0
|
|
25
|
+
Requires-Dist: pyfiglet>=1.0.2
|
|
26
|
+
Requires-Dist: questionary>=2.0.0
|
|
27
|
+
Requires-Dist: rich>=13.0.0
|
|
28
|
+
Provides-Extra: dev
|
|
29
|
+
Requires-Dist: mypy>=1.7.0; extra == 'dev'
|
|
30
|
+
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
|
|
32
|
+
Requires-Dist: pytest>=8.4.2; extra == 'dev'
|
|
33
|
+
Requires-Dist: ruff>=0.1.0; extra == 'dev'
|
|
34
|
+
Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
|
|
35
|
+
Provides-Extra: security
|
|
36
|
+
Requires-Dist: bandit>=1.8.0; extra == 'security'
|
|
37
|
+
Requires-Dist: pip-audit>=2.7.0; extra == 'security'
|
|
38
|
+
Description-Content-Type: text/markdown
|
|
39
|
+
|
|
40
|
+
# MoAI-ADK (Agentic Development Kit)
|
|
41
|
+
|
|
42
|
+
[English](README.md) | [한국어](README.ko.md) | [ไทย](README.th.md) | [日本語](README.ja.md) | [中文](README.zh.md) | [हिन्दी](README.hi.md)
|
|
43
|
+
|
|
44
|
+
[](https://pypi.org/project/moai-adk/)
|
|
45
|
+
[](https://opensource.org/licenses/MIT)
|
|
46
|
+
[](https://www.python.org/)
|
|
47
|
+
[](https://github.com/modu-ai/moai-adk/actions/workflows/moai-gitflow.yml)
|
|
48
|
+
[](https://codecov.io/gh/modu-ai/moai-adk)
|
|
49
|
+
[](https://github.com/modu-ai/moai-adk)
|
|
50
|
+
|
|
51
|
+
> **MoAI-ADK delivers a seamless development workflow that naturally connects SPEC → TEST (TDD) → CODE → DOCUMENTATION with AI.**
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 1. MoAI-ADK at a Glance
|
|
56
|
+
|
|
57
|
+
MoAI-ADK transforms AI-powered development with three core principles. Use the navigation below to jump to the section that matches your needs.
|
|
58
|
+
|
|
59
|
+
If you're **new to MoAI-ADK**, start with "What is MoAI-ADK?".
|
|
60
|
+
If you want to **get started quickly**, jump straight to "5-Minute Quick Start".
|
|
61
|
+
If you've **already installed it and want to understand the concepts**, we recommend "5 Key Concepts".
|
|
62
|
+
|
|
63
|
+
| Question | Jump To |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| First time here—what is it? | [What is MoAI-ADK?](#what-is-moai-adk) |
|
|
66
|
+
| How do I get started? | [5-Minute Quick Start](#5-minute-quick-start) |
|
|
67
|
+
| What's the basic flow? | [Core Workflow (0 → 3)](#core-workflow-0--3) |
|
|
68
|
+
| What do Plan/Run/Sync commands do? | [Command Cheat Sheet](#command-cheat-sheet) |
|
|
69
|
+
| What are SPEC, TDD, TAG? | [5 Key Concepts](#5-key-concepts) |
|
|
70
|
+
| Tell me about agents/Skills | [Sub-agents & Skills Overview](#sub-agents--skills-overview) |
|
|
71
|
+
| Want to dive deeper? | [Additional Resources](#additional-resources) |
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## What is MoAI-ADK?
|
|
76
|
+
|
|
77
|
+
### The Problem: Trust Crisis in AI Development
|
|
78
|
+
|
|
79
|
+
Today, countless developers want help from Claude or ChatGPT, but can't shake one fundamental doubt: **"Can I really trust the code this AI generates?"**
|
|
80
|
+
|
|
81
|
+
The reality looks like this. Ask an AI to "build a login feature" and you'll get syntactically perfect code. But these problems keep repeating:
|
|
82
|
+
|
|
83
|
+
- **Unclear Requirements**: The basic question "What exactly should we build?" remains unanswered. Email/password login? OAuth? 2FA? Everything relies on guessing.
|
|
84
|
+
- **Missing Tests**: Most AIs only test the "happy path". Wrong password? Network error? Three months later, bugs explode in production.
|
|
85
|
+
- **Documentation Drift**: Code gets modified but docs stay the same. The question "Why is this code here?" keeps repeating.
|
|
86
|
+
- **Context Loss**: Even within the same project, you have to explain everything from scratch each time. Project structure, decision rationale, previous attempts—nothing gets recorded.
|
|
87
|
+
- **Impact Tracking Impossible**: When requirements change, you can't track which code is affected.
|
|
88
|
+
|
|
89
|
+
### The Solution: SPEC-First TDD with Alfred SuperAgent
|
|
90
|
+
|
|
91
|
+
**MoAI-ADK** (MoAI Agentic Development Kit) is an open-source framework designed to **systematically solve** these problems.
|
|
92
|
+
|
|
93
|
+
The core principle is simple yet powerful:
|
|
94
|
+
|
|
95
|
+
> **"No tests without code, no SPEC without tests"**
|
|
96
|
+
|
|
97
|
+
More precisely, it's the reverse order:
|
|
98
|
+
|
|
99
|
+
> **"SPEC comes first. No tests without SPEC. No complete documentation without tests and code."**
|
|
100
|
+
|
|
101
|
+
When you follow this order, magical things happen:
|
|
102
|
+
|
|
103
|
+
**1️⃣ Clear Requirements**
|
|
104
|
+
Write SPECs first with the `/alfred:1-plan` command. A vague request like "login feature" transforms into **clear requirements** like "WHEN valid credentials are provided, the system SHALL issue a JWT token". Alfred's spec-builder uses EARS syntax to create professional SPECs in just 3 minutes.
|
|
105
|
+
|
|
106
|
+
**2️⃣ Test Guarantee**
|
|
107
|
+
`/alfred:2-run` automatically performs Test-Driven Development (TDD). It proceeds in RED (failing test) → GREEN (minimal implementation) → REFACTOR (cleanup) order, **guaranteeing 85%+ test coverage**. No more "testing later". Tests drive code creation.
|
|
108
|
+
|
|
109
|
+
**3️⃣ Automatic Documentation Sync**
|
|
110
|
+
A single `/alfred:3-sync` command **synchronizes** all code, tests, and documentation. README, CHANGELOG, API docs, and Living Documents all update automatically. Six months later, code and docs still match.
|
|
111
|
+
|
|
112
|
+
**4️⃣ Tracking with @TAG System**
|
|
113
|
+
Every piece of code, test, and documentation gets a `@TAG:ID`. When requirements change later, one command—`rg "@SPEC:AUTH-001"`—**finds all related tests, implementations, and docs**. You gain confidence during refactoring.
|
|
114
|
+
|
|
115
|
+
**5️⃣ Alfred Remembers Context**
|
|
116
|
+
19 AI agents (1 Alfred SuperAgent + 10 Core Sub-agents + 6 Zero-project Specialists + 2 Built-in Agents) collaborate to **remember** your project's structure, decision rationale, and work history. No need to repeat the same questions.
|
|
117
|
+
|
|
118
|
+
### MoAI-ADK's 3 Core Promises
|
|
119
|
+
|
|
120
|
+
For beginners to remember easily, MoAI-ADK's value simplifies to three things:
|
|
121
|
+
|
|
122
|
+
**First, SPEC comes before code**
|
|
123
|
+
Start by clearly defining what to build. Writing SPEC helps discover problems before implementation. Communication costs with teammates drop dramatically.
|
|
124
|
+
|
|
125
|
+
**Second, tests drive code (TDD)**
|
|
126
|
+
Write tests before implementation (RED). Implement minimally to pass tests (GREEN). Then clean up the code (REFACTOR). Result: fewer bugs, confidence in refactoring, code anyone can understand.
|
|
127
|
+
|
|
128
|
+
**Third, documentation and code always match**
|
|
129
|
+
One `/alfred:3-sync` command auto-updates all documentation. README, CHANGELOG, API docs, and Living Documents always sync with code. No more despair when modifying six-month-old code.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Why Do You Need It?
|
|
134
|
+
|
|
135
|
+
### Real Challenges in AI Development
|
|
136
|
+
|
|
137
|
+
Modern AI-powered development faces various challenges. MoAI-ADK **systematically solves** all these problems:
|
|
138
|
+
|
|
139
|
+
| Concern | Traditional Approach Problem | MoAI-ADK Solution |
|
|
140
|
+
| --- | --- | --- |
|
|
141
|
+
| "Can't trust AI code" | Implementation without tests, unclear verification | Enforces SPEC → TEST → CODE order, guarantees 85%+ coverage |
|
|
142
|
+
| "Repeating same explanations" | Context loss, unrecorded project history | Alfred remembers everything, 19 AI team members collaborate |
|
|
143
|
+
| "Hard to write prompts" | Don't know how to write good prompts | `/alfred` commands provide standardized prompts automatically |
|
|
144
|
+
| "Documentation always outdated" | Forget to update docs after code changes | `/alfred:3-sync` auto-syncs with one command |
|
|
145
|
+
| "Don't know what changed where" | Hard to search code, unclear intent | @TAG chain connects SPEC → TEST → CODE → DOC |
|
|
146
|
+
| "Team onboarding takes forever" | New members can't grasp code context | Reading SPEC makes intent immediately clear |
|
|
147
|
+
|
|
148
|
+
### Benefits You Can Experience Right Now
|
|
149
|
+
|
|
150
|
+
From the moment you adopt MoAI-ADK, you'll feel:
|
|
151
|
+
|
|
152
|
+
- **Faster Development**: Clear SPEC reduces round-trip explanation time
|
|
153
|
+
- **Fewer Bugs**: SPEC-based tests catch issues early
|
|
154
|
+
- **Better Code Understanding**: @TAG and SPEC make intent immediately clear
|
|
155
|
+
- **Lower Maintenance Costs**: Code and docs always match
|
|
156
|
+
- **Efficient Team Collaboration**: Clear communication through SPEC and TAG
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## 5-Minute Quick Start
|
|
161
|
+
|
|
162
|
+
Now let's start your first project with MoAI-ADK. Follow these 5 steps and in just **5 minutes** you'll have a project with SPEC, TDD, and documentation all connected.
|
|
163
|
+
|
|
164
|
+
### Step 1: Install uv (about 30 seconds)
|
|
165
|
+
|
|
166
|
+
First, install `uv`. `uv` is an ultra-fast Python package manager written in Rust. It's **10+ times faster** than traditional `pip` and works perfectly with MoAI-ADK.
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
# macOS/Linux
|
|
170
|
+
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
171
|
+
|
|
172
|
+
# Windows (PowerShell)
|
|
173
|
+
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
|
|
174
|
+
|
|
175
|
+
# Verify installation
|
|
176
|
+
uv --version
|
|
177
|
+
# Output: uv 0.x.x
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
**Why uv?** MoAI-ADK is optimized to leverage uv's fast installation speed and stability. Perfect project isolation means no impact on other Python environments.
|
|
181
|
+
|
|
182
|
+
### Step 2: Install MoAI-ADK (about 1 minute)
|
|
183
|
+
|
|
184
|
+
Install MoAI-ADK as a global tool. This won't affect your project dependencies.
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
# Install in tool mode (recommended: runs in isolated environment)
|
|
188
|
+
uv tool install moai-adk
|
|
189
|
+
|
|
190
|
+
# Verify installation
|
|
191
|
+
moai-adk --version
|
|
192
|
+
# Output: MoAI-ADK v0.4.6
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Once installed, you can use the `moai-adk` command anywhere.
|
|
196
|
+
|
|
197
|
+
### Step 3: Create Project (about 1 minute)
|
|
198
|
+
|
|
199
|
+
**To start a new project:**
|
|
200
|
+
```bash
|
|
201
|
+
moai-adk init my-project
|
|
202
|
+
cd my-project
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
**To add to an existing project:**
|
|
206
|
+
```bash
|
|
207
|
+
cd your-existing-project
|
|
208
|
+
moai-adk init .
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
This one command automatically generates:
|
|
212
|
+
|
|
213
|
+
```
|
|
214
|
+
my-project/
|
|
215
|
+
├── .moai/ # MoAI-ADK project configuration
|
|
216
|
+
│ ├── config.json
|
|
217
|
+
│ ├── project/ # Project information
|
|
218
|
+
│ ├── specs/ # SPEC files
|
|
219
|
+
│ └── reports/ # Analysis reports
|
|
220
|
+
├── .claude/ # Claude Code automation
|
|
221
|
+
│ ├── agents/ # 19-member AI team
|
|
222
|
+
│ ├── commands/ # /alfred commands
|
|
223
|
+
│ ├── skills/ # 56 Claude Skills
|
|
224
|
+
│ └── settings.json
|
|
225
|
+
├── src/ # Implementation code
|
|
226
|
+
├── tests/ # Test code
|
|
227
|
+
├── docs/ # Auto-generated documentation
|
|
228
|
+
└── README.md
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### Step 4: Start Alfred in Claude Code (about 2 minutes)
|
|
232
|
+
|
|
233
|
+
Run Claude Code and invoke the Alfred SuperAgent:
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
# Run Claude Code
|
|
237
|
+
claude
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
Then enter this in Claude Code's command input:
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
/alfred:0-project
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
This command performs:
|
|
247
|
+
|
|
248
|
+
1. **Collect Project Info**: "Project name?", "Goals?", "Main language?"
|
|
249
|
+
2. **Auto-detect Tech Stack**: Automatically recognizes Python/JavaScript/Go, etc.
|
|
250
|
+
3. **Deploy Skill Packs**: Prepares necessary Skills from the 56 available
|
|
251
|
+
4. **Generate Initial Report**: Project structure, suggested next steps
|
|
252
|
+
|
|
253
|
+
### Step 5: Write First SPEC (about 1 minute)
|
|
254
|
+
|
|
255
|
+
After project initialization completes, write your first feature as a SPEC:
|
|
256
|
+
|
|
257
|
+
```
|
|
258
|
+
/alfred:1-plan "User registration feature"
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
Automatically generated:
|
|
262
|
+
- `@SPEC:USER-001` - Unique ID assigned
|
|
263
|
+
- `.moai/specs/SPEC-USER-001/spec.md` - Professional SPEC in EARS format
|
|
264
|
+
- `feature/spec-user-001` - Git branch auto-created
|
|
265
|
+
|
|
266
|
+
### Step 6: TDD Implementation (about 3 minutes)
|
|
267
|
+
|
|
268
|
+
Once SPEC is written, implement using TDD:
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
/alfred:2-run USER-001
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
This command handles:
|
|
275
|
+
- 🔴 **RED**: Automatically write failing test (`@TEST:USER-001`)
|
|
276
|
+
- 🟢 **GREEN**: Minimal implementation to pass test (`@CODE:USER-001`)
|
|
277
|
+
- ♻️ **REFACTOR**: Improve code quality
|
|
278
|
+
|
|
279
|
+
### Step 7: Documentation Sync (about 1 minute)
|
|
280
|
+
|
|
281
|
+
Finally, auto-sync all documentation:
|
|
282
|
+
|
|
283
|
+
```
|
|
284
|
+
/alfred:3-sync
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
Automatically generated/updated:
|
|
288
|
+
- Living Document (API documentation)
|
|
289
|
+
- README updates
|
|
290
|
+
- CHANGELOG generation
|
|
291
|
+
- @TAG chain validation
|
|
292
|
+
|
|
293
|
+
### Complete!
|
|
294
|
+
|
|
295
|
+
After these 7 steps, everything is ready:
|
|
296
|
+
|
|
297
|
+
✅ Requirements specification (SPEC)
|
|
298
|
+
✅ Test code (85%+ coverage)
|
|
299
|
+
✅ Implementation code (tracked with @TAG)
|
|
300
|
+
✅ API documentation (auto-generated)
|
|
301
|
+
✅ Change history (CHANGELOG)
|
|
302
|
+
✅ Git commit history (RED/GREEN/REFACTOR)
|
|
303
|
+
|
|
304
|
+
**Everything completes in 15 minutes!**
|
|
305
|
+
|
|
306
|
+
### Verify Generated Results
|
|
307
|
+
|
|
308
|
+
Check if the generated results were properly created:
|
|
309
|
+
|
|
310
|
+
```bash
|
|
311
|
+
# 1. Check TAG chain (SPEC → TEST → CODE → DOC)
|
|
312
|
+
rg '@(SPEC|TEST|CODE):USER-001' -n
|
|
313
|
+
|
|
314
|
+
# 2. Run tests
|
|
315
|
+
pytest tests/ -v
|
|
316
|
+
|
|
317
|
+
# 3. Check generated documentation
|
|
318
|
+
cat docs/api/user.md
|
|
319
|
+
cat README.md
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
> 🔍 **Verification Command**: `moai-adk doctor` — Checks if Python/uv versions, `.moai/` structure, and agent/Skills configuration are all ready.
|
|
323
|
+
> ```bash
|
|
324
|
+
> moai-adk doctor
|
|
325
|
+
> ```
|
|
326
|
+
> All green checkmarks mean perfect readiness!
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
## Keeping MoAI-ADK Up-to-Date
|
|
331
|
+
|
|
332
|
+
### Check Version
|
|
333
|
+
```bash
|
|
334
|
+
# Check currently installed version
|
|
335
|
+
moai-adk --version
|
|
336
|
+
|
|
337
|
+
# Check latest version on PyPI
|
|
338
|
+
uv tool list # Check current version of moai-adk
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Upgrading
|
|
342
|
+
|
|
343
|
+
#### Method 1: MoAI-ADK Built-in Update Command (Simplest)
|
|
344
|
+
```bash
|
|
345
|
+
# MoAI-ADK's own update command - also updates agent/Skills templates
|
|
346
|
+
moai-adk update
|
|
347
|
+
|
|
348
|
+
# Apply new templates to project after update (optional)
|
|
349
|
+
moai-adk init .
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
#### Method 2: Upgrade with uv tool command
|
|
353
|
+
|
|
354
|
+
**Upgrade specific tool (recommended)**
|
|
355
|
+
```bash
|
|
356
|
+
# Upgrade only moai-adk to latest version
|
|
357
|
+
uv tool upgrade moai-adk
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
**Upgrade all installed tools**
|
|
361
|
+
```bash
|
|
362
|
+
# Upgrade all uv tool installations to latest versions
|
|
363
|
+
uv tool update
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
**Install specific version**
|
|
367
|
+
```bash
|
|
368
|
+
# Reinstall specific version (e.g., 0.4.2)
|
|
369
|
+
uv tool install moai-adk==0.4.2
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Verify After Update
|
|
373
|
+
```bash
|
|
374
|
+
# 1. Check installed version
|
|
375
|
+
moai-adk --version
|
|
376
|
+
|
|
377
|
+
# 2. Verify project works correctly
|
|
378
|
+
moai-adk doctor
|
|
379
|
+
|
|
380
|
+
# 3. Apply new templates to existing project (if needed)
|
|
381
|
+
cd your-project
|
|
382
|
+
moai-adk init . # Keeps existing code, updates only .moai/ structure and templates
|
|
383
|
+
|
|
384
|
+
# 4. Check updated features in Alfred
|
|
385
|
+
cd your-project
|
|
386
|
+
claude
|
|
387
|
+
/alfred:0-project # Verify new features like language selection
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
> 💡 **Tip**:
|
|
391
|
+
> - `moai-adk update`: Updates MoAI-ADK package version + syncs agent/Skills templates
|
|
392
|
+
> - `moai-adk init .`: Applies new templates to existing project (keeps code safe)
|
|
393
|
+
> - Running both commands completes a full update
|
|
394
|
+
> - When major updates (minor/major) release, run these procedures to utilize new agents/Skills
|
|
395
|
+
|
|
396
|
+
---
|
|
397
|
+
|
|
398
|
+
## Core Workflow (0 → 3)
|
|
399
|
+
|
|
400
|
+
Alfred iteratively develops projects with four commands.
|
|
401
|
+
|
|
402
|
+
```mermaid
|
|
403
|
+
%%{init: {'theme':'neutral'}}%%
|
|
404
|
+
graph TD
|
|
405
|
+
Start([User Request]) --> Init[0. Init<br/>/alfred:0-project]
|
|
406
|
+
Init --> Plan[1. Plan & SPEC<br/>/alfred:1-plan]
|
|
407
|
+
Plan --> Run[2. Run & TDD<br/>/alfred:2-run]
|
|
408
|
+
Run --> Sync[3. Sync & Docs<br/>/alfred:3-sync]
|
|
409
|
+
Sync --> Plan
|
|
410
|
+
Sync -.-> End([Release])
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### 0. INIT — Project Preparation
|
|
414
|
+
- Questions about project introduction, target, language, mode (locale)
|
|
415
|
+
- Auto-generates `.moai/config.json`, `.moai/project/*` 5 documents
|
|
416
|
+
- Language detection and recommended Skill Pack deployment (Foundation + Essentials + Domain/Language)
|
|
417
|
+
- Template cleanup, initial Git/backup checks
|
|
418
|
+
|
|
419
|
+
### 1. PLAN — Agree on What to Build
|
|
420
|
+
- Write SPEC with EARS template (includes `@SPEC:ID`)
|
|
421
|
+
- Organize Plan Board, implementation ideas, risk factors
|
|
422
|
+
- Auto-create branch/initial Draft PR in Team mode
|
|
423
|
+
|
|
424
|
+
### 2. RUN — Test-Driven Development (TDD)
|
|
425
|
+
- Phase 1 `implementation-planner`: Design libraries, folders, TAG layout
|
|
426
|
+
- Phase 2 `tdd-implementer`: RED (failing test) → GREEN (minimal implementation) → REFACTOR (cleanup)
|
|
427
|
+
- quality-gate verifies TRUST 5 principles, coverage changes
|
|
428
|
+
|
|
429
|
+
### 3. SYNC — Documentation & PR Organization
|
|
430
|
+
- Sync Living Document, README, CHANGELOG, etc.
|
|
431
|
+
- Validate TAG chain and recover orphan TAGs
|
|
432
|
+
- Generate Sync Report, transition Draft → Ready for Review, support `--auto-merge` option
|
|
433
|
+
|
|
434
|
+
---
|
|
435
|
+
|
|
436
|
+
## Command Cheat Sheet
|
|
437
|
+
|
|
438
|
+
| Command | What it does | Key Outputs |
|
|
439
|
+
| --- | --- | --- |
|
|
440
|
+
| `/alfred:0-project` | Collect project description, create config/docs, recommend Skills | `.moai/config.json`, `.moai/project/*`, initial report |
|
|
441
|
+
| `/alfred:1-plan <description>` | Analyze requirements, draft SPEC, write Plan Board | `.moai/specs/SPEC-*/spec.md`, plan/acceptance docs, feature branch |
|
|
442
|
+
| `/alfred:2-run <SPEC-ID>` | Execute TDD, test/implement/refactor, verify quality | `tests/`, `src/` implementation, quality report, TAG connection |
|
|
443
|
+
| `/alfred:3-sync` | Sync docs/README/CHANGELOG, organize TAG/PR status | `docs/`, `.moai/reports/sync-report.md`, Ready PR |
|
|
444
|
+
|
|
445
|
+
> ❗ All commands maintain **Phase 0 (optional) → Phase 1 → Phase 2 → Phase 3** cycle structure. Alfred automatically reports execution status and next-step suggestions.
|
|
446
|
+
|
|
447
|
+
---
|
|
448
|
+
|
|
449
|
+
## 5 Key Concepts
|
|
450
|
+
|
|
451
|
+
MoAI-ADK consists of 5 key concepts. Each concept connects to the others, and together they create a powerful development system.
|
|
452
|
+
|
|
453
|
+
### Key Concept 1: SPEC-First (Requirements First)
|
|
454
|
+
|
|
455
|
+
**Metaphor**: Like building a house without an architect, you shouldn't code without a blueprint.
|
|
456
|
+
|
|
457
|
+
**Core Idea**: Before implementation, **clearly define "what to build"**. This isn't just documentation—it's an **executable spec** that both teams and AI can understand.
|
|
458
|
+
|
|
459
|
+
**EARS Syntax 5 Patterns**:
|
|
460
|
+
|
|
461
|
+
1. **Ubiquitous** (basic function): "The system SHALL provide JWT-based authentication"
|
|
462
|
+
2. **Event-driven** (conditional): "WHEN valid credentials are provided, the system SHALL issue a token"
|
|
463
|
+
3. **State-driven** (during state): "WHILE the user is authenticated, the system SHALL allow access to protected resources"
|
|
464
|
+
4. **Optional** (optional): "WHERE a refresh token exists, the system MAY issue a new token"
|
|
465
|
+
5. **Constraints** (constraints): "Token expiration time SHALL NOT exceed 15 minutes"
|
|
466
|
+
|
|
467
|
+
**How?** The `/alfred:1-plan` command automatically creates professional SPECs in EARS format.
|
|
468
|
+
|
|
469
|
+
**What You Get**:
|
|
470
|
+
- ✅ Clear requirements everyone on the team understands
|
|
471
|
+
- ✅ SPEC-based test cases (what to test is already defined)
|
|
472
|
+
- ✅ When requirements change, track all affected code with `@SPEC:ID` TAG
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
### Key Concept 2: TDD (Test-Driven Development)
|
|
477
|
+
|
|
478
|
+
**Metaphor**: Like finding the route after setting a destination, you set goals with tests, then write code.
|
|
479
|
+
|
|
480
|
+
**Core Idea**: Write tests **before** implementation. Like checking ingredients before cooking, this clarifies requirements before implementation.
|
|
481
|
+
|
|
482
|
+
**3-Step Cycle**:
|
|
483
|
+
|
|
484
|
+
1. **🔴 RED**: Write a failing test first
|
|
485
|
+
- Each SPEC requirement becomes a test case
|
|
486
|
+
- Must fail because implementation doesn't exist yet
|
|
487
|
+
- Git commit: `test(AUTH-001): add failing test`
|
|
488
|
+
|
|
489
|
+
2. **🟢 GREEN**: Minimal implementation to pass the test
|
|
490
|
+
- Make it pass using the simplest approach
|
|
491
|
+
- Passing comes before perfection
|
|
492
|
+
- Git commit: `feat(AUTH-001): implement minimal solution`
|
|
493
|
+
|
|
494
|
+
3. **♻️ REFACTOR**: Clean up and improve code
|
|
495
|
+
- Apply TRUST 5 principles
|
|
496
|
+
- Remove duplication, improve readability
|
|
497
|
+
- Tests must still pass
|
|
498
|
+
- Git commit: `refactor(AUTH-001): improve code quality`
|
|
499
|
+
|
|
500
|
+
**How?** The `/alfred:2-run` command automatically executes these 3 steps.
|
|
501
|
+
|
|
502
|
+
**What You Get**:
|
|
503
|
+
- ✅ Guaranteed 85%+ coverage (no code without tests)
|
|
504
|
+
- ✅ Refactoring confidence (always verifiable with tests)
|
|
505
|
+
- ✅ Clear Git history (trace RED → GREEN → REFACTOR process)
|
|
506
|
+
|
|
507
|
+
---
|
|
508
|
+
|
|
509
|
+
### Key Concept 3: @TAG System
|
|
510
|
+
|
|
511
|
+
**Metaphor**: Like package tracking numbers, you should be able to trace code's journey.
|
|
512
|
+
|
|
513
|
+
**Core Idea**: Add `@TAG:ID` to all SPECs, tests, code, and documentation to create **one-to-one correspondence**.
|
|
514
|
+
|
|
515
|
+
**TAG Chain**:
|
|
516
|
+
```
|
|
517
|
+
@SPEC:AUTH-001 (requirements)
|
|
518
|
+
↓
|
|
519
|
+
@TEST:AUTH-001 (test)
|
|
520
|
+
↓
|
|
521
|
+
@CODE:AUTH-001 (implementation)
|
|
522
|
+
↓
|
|
523
|
+
@DOC:AUTH-001 (documentation)
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
**TAG ID Rules**: `<Domain>-<3 digits>`
|
|
527
|
+
- AUTH-001, AUTH-002, AUTH-003...
|
|
528
|
+
- USER-001, USER-002...
|
|
529
|
+
- Once assigned, **never change**
|
|
530
|
+
|
|
531
|
+
**How to Use?** When requirements change:
|
|
532
|
+
```bash
|
|
533
|
+
# Find everything related to AUTH-001
|
|
534
|
+
rg '@TAG:AUTH-001' -n
|
|
535
|
+
|
|
536
|
+
# Result: Shows all SPEC, TEST, CODE, DOC at once
|
|
537
|
+
# → Clear what needs modification
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
**How?** The `/alfred:3-sync` command validates TAG chains and detects orphan TAGs (TAGs without correspondence).
|
|
541
|
+
|
|
542
|
+
**What You Get**:
|
|
543
|
+
- ✅ Clear intent for all code (reading SPEC explains why this code exists)
|
|
544
|
+
- ✅ Instantly identify all affected code during refactoring
|
|
545
|
+
- ✅ Code remains understandable 3 months later (trace TAG → SPEC)
|
|
546
|
+
|
|
547
|
+
---
|
|
548
|
+
|
|
549
|
+
### Key Concept 4: TRUST 5 Principles
|
|
550
|
+
|
|
551
|
+
**Metaphor**: Like a healthy body, good code must satisfy all 5 elements.
|
|
552
|
+
|
|
553
|
+
**Core Idea**: All code must follow these 5 principles. `/alfred:3-sync` automatically verifies them.
|
|
554
|
+
|
|
555
|
+
1. **🧪 Test First** (tests come first)
|
|
556
|
+
- Test coverage ≥ 85%
|
|
557
|
+
- All code protected by tests
|
|
558
|
+
- Adding feature = adding test
|
|
559
|
+
|
|
560
|
+
2. **📖 Readable** (easy-to-read code)
|
|
561
|
+
- Functions ≤ 50 lines, files ≤ 300 lines
|
|
562
|
+
- Variable names reveal intent
|
|
563
|
+
- Pass linters (ESLint/ruff/clippy)
|
|
564
|
+
|
|
565
|
+
3. **🎯 Unified** (consistent structure)
|
|
566
|
+
- Maintain SPEC-based architecture
|
|
567
|
+
- Same patterns repeat (reduces learning curve)
|
|
568
|
+
- Type safety or runtime validation
|
|
569
|
+
|
|
570
|
+
4. **🔒 Secured** (security)
|
|
571
|
+
- Input validation (defend against XSS, SQL Injection)
|
|
572
|
+
- Password hashing (bcrypt, Argon2)
|
|
573
|
+
- Protect sensitive information (environment variables)
|
|
574
|
+
|
|
575
|
+
5. **🔗 Trackable** (traceability)
|
|
576
|
+
- Use @TAG system
|
|
577
|
+
- Include TAG in Git commits
|
|
578
|
+
- Document all decisions
|
|
579
|
+
|
|
580
|
+
**How?** The `/alfred:3-sync` command automatically performs TRUST verification.
|
|
581
|
+
|
|
582
|
+
**What You Get**:
|
|
583
|
+
- ✅ Production-quality code guaranteed
|
|
584
|
+
- ✅ Entire team develops with same standards
|
|
585
|
+
- ✅ Fewer bugs, prevent security vulnerabilities in advance
|
|
586
|
+
|
|
587
|
+
---
|
|
588
|
+
|
|
589
|
+
### Key Concept 5: Alfred SuperAgent
|
|
590
|
+
|
|
591
|
+
**Metaphor**: Like a personal assistant, Alfred handles all the complex work.
|
|
592
|
+
|
|
593
|
+
**Core Idea**: **19 AI agents** collaborate to automate the entire development process:
|
|
594
|
+
|
|
595
|
+
**Agent Composition**:
|
|
596
|
+
- **Alfred SuperAgent**: Overall orchestration (1)
|
|
597
|
+
- **Core Sub-agents**: Specialized tasks like SPEC writing, TDD implementation, documentation sync (10)
|
|
598
|
+
- **Zero-project Specialists**: Project initialization, language detection, etc. (6)
|
|
599
|
+
- **Built-in Agents**: General questions, codebase exploration (2)
|
|
600
|
+
|
|
601
|
+
**56 Claude Skills**:
|
|
602
|
+
- **Foundation** (6): TRUST/TAG/SPEC/Git/EARS principles
|
|
603
|
+
- **Essentials** (4): Debugging, performance, refactoring, code review
|
|
604
|
+
- **Alfred** (11): Workflow automation
|
|
605
|
+
- **Domain** (10): Backend, frontend, security, etc.
|
|
606
|
+
- **Language** (24): Python, JavaScript, Go, Rust, etc.
|
|
607
|
+
- **Ops** (1): Claude Code session management
|
|
608
|
+
|
|
609
|
+
**How?** `/alfred:*` commands automatically activate the right expert team.
|
|
610
|
+
|
|
611
|
+
**What You Get**:
|
|
612
|
+
- ✅ No prompt writing needed (use standardized commands)
|
|
613
|
+
- ✅ Automatically remember project context (no repeating same questions)
|
|
614
|
+
- ✅ Auto-assemble optimal expert team (activate appropriate Sub-agents)
|
|
615
|
+
|
|
616
|
+
> **Want to learn more?** Check detailed rules in `.moai/memory/development-guide.md`.
|
|
617
|
+
|
|
618
|
+
---
|
|
619
|
+
|
|
620
|
+
## First Hands-on: Todo API Example
|
|
621
|
+
|
|
622
|
+
Let's now **experience MoAI-ADK's complete workflow** firsthand. We'll build a simple "Todo Management API" and see how SPEC, TDD, and documentation connect.
|
|
623
|
+
|
|
624
|
+
### Step 1: PLAN - Write SPEC (about 3 minutes)
|
|
625
|
+
|
|
626
|
+
```bash
|
|
627
|
+
/alfred:1-plan "Todo add, view, update, delete API"
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
**Execution Result**:
|
|
631
|
+
|
|
632
|
+
Alfred's **spec-builder** automatically generates:
|
|
633
|
+
|
|
634
|
+
```yaml
|
|
635
|
+
# .moai/specs/SPEC-TODO-001/spec.md
|
|
636
|
+
|
|
637
|
+
---
|
|
638
|
+
id: TODO-001
|
|
639
|
+
version: 0.0.1
|
|
640
|
+
status: draft
|
|
641
|
+
created: 2025-10-22
|
|
642
|
+
updated: 2025-10-22
|
|
643
|
+
author: @user
|
|
644
|
+
priority: high
|
|
645
|
+
---
|
|
646
|
+
|
|
647
|
+
# @SPEC:TODO-001: Todo Management API
|
|
648
|
+
|
|
649
|
+
## Ubiquitous Requirements
|
|
650
|
+
- The system SHALL be able to add todos
|
|
651
|
+
- The system SHALL be able to view all todos
|
|
652
|
+
- The system SHALL be able to update specific todos
|
|
653
|
+
- The system SHALL be able to delete todos
|
|
654
|
+
|
|
655
|
+
## Event-driven Requirements
|
|
656
|
+
- WHEN a new todo is requested via POST /todos, the system SHALL save the todo and return a 201 response
|
|
657
|
+
- WHEN GET /todos/{id} is requested with an existing todo ID, the system SHALL return that todo
|
|
658
|
+
- WHEN GET is requested with a non-existent todo ID, the system SHALL return a 404 error
|
|
659
|
+
|
|
660
|
+
## Constraints
|
|
661
|
+
- Todo title SHALL be minimum 1 character, maximum 200 characters
|
|
662
|
+
- Each todo SHALL automatically record creation time
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
**Also auto-generated**:
|
|
666
|
+
- 📋 `Plan Board`: Implementation ideas, risk factors, solution strategies
|
|
667
|
+
- ✅ `Acceptance Criteria`: Verification standards
|
|
668
|
+
- 🌿 `feature/spec-todo-001` Git branch
|
|
669
|
+
|
|
670
|
+
### Step 2: RUN - TDD Implementation (about 5 minutes)
|
|
671
|
+
|
|
672
|
+
```bash
|
|
673
|
+
/alfred:2-run TODO-001
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
**Phase 1: Establish Implementation Strategy**
|
|
677
|
+
|
|
678
|
+
The **implementation-planner** Sub-agent decides:
|
|
679
|
+
- 📚 Libraries: FastAPI + SQLAlchemy
|
|
680
|
+
- 📁 Folder structure: `src/todo/`, `tests/todo/`
|
|
681
|
+
- 🏷️ TAG design: `@CODE:TODO-001:API`, `@CODE:TODO-001:MODEL`, `@CODE:TODO-001:REPO`
|
|
682
|
+
|
|
683
|
+
**Phase 2: RED → GREEN → REFACTOR**
|
|
684
|
+
|
|
685
|
+
**🔴 RED: Write Tests First**
|
|
686
|
+
|
|
687
|
+
```python
|
|
688
|
+
# tests/test_todo_api.py
|
|
689
|
+
# @TEST:TODO-001 | SPEC: SPEC-TODO-001.md
|
|
690
|
+
|
|
691
|
+
import pytest
|
|
692
|
+
from src.todo.api import create_todo, get_todos
|
|
693
|
+
|
|
694
|
+
def test_create_todo_should_return_201_with_todo_id():
|
|
695
|
+
"""WHEN a new todo is requested via POST /todos,
|
|
696
|
+
the system SHALL save the todo and return a 201 response"""
|
|
697
|
+
response = create_todo({"title": "Buy groceries"})
|
|
698
|
+
assert response.status_code == 201
|
|
699
|
+
assert "id" in response.json()
|
|
700
|
+
assert response.json()["title"] == "Buy groceries"
|
|
701
|
+
|
|
702
|
+
def test_get_todos_should_return_all_todos():
|
|
703
|
+
"""The system SHALL be able to view all todos"""
|
|
704
|
+
create_todo({"title": "Task 1"})
|
|
705
|
+
create_todo({"title": "Task 2"})
|
|
706
|
+
|
|
707
|
+
response = get_todos()
|
|
708
|
+
assert response.status_code == 200
|
|
709
|
+
assert len(response.json()) >= 2
|
|
710
|
+
|
|
711
|
+
def test_get_todo_with_invalid_id_should_return_404():
|
|
712
|
+
"""WHEN GET is requested with a non-existent todo ID,
|
|
713
|
+
the system SHALL return a 404 error"""
|
|
714
|
+
response = get_todo(999)
|
|
715
|
+
assert response.status_code == 404
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
**Execute**: `pytest tests/test_todo_api.py -v`
|
|
719
|
+
**Result**: ❌ All fail (create_todo not defined)
|
|
720
|
+
|
|
721
|
+
**Git Commit**:
|
|
722
|
+
```bash
|
|
723
|
+
git commit -m "🔴 test(TODO-001): add failing API tests"
|
|
724
|
+
```
|
|
725
|
+
|
|
726
|
+
**🟢 GREEN: Minimal Implementation**
|
|
727
|
+
|
|
728
|
+
```python
|
|
729
|
+
# src/todo/api.py
|
|
730
|
+
# @CODE:TODO-001:API | SPEC: SPEC-TODO-001.md | TEST: tests/test_todo_api.py
|
|
731
|
+
|
|
732
|
+
from fastapi import FastAPI, HTTPException
|
|
733
|
+
from pydantic import BaseModel
|
|
734
|
+
import uuid
|
|
735
|
+
|
|
736
|
+
app = FastAPI()
|
|
737
|
+
todos_db = {}
|
|
738
|
+
|
|
739
|
+
class TodoRequest(BaseModel):
|
|
740
|
+
title: str
|
|
741
|
+
|
|
742
|
+
@app.post("/todos", status_code=201)
|
|
743
|
+
def create_todo(todo: TodoRequest):
|
|
744
|
+
"""@CODE:TODO-001:API - POST endpoint"""
|
|
745
|
+
todo_id = str(uuid.uuid4())
|
|
746
|
+
todos_db[todo_id] = {"id": todo_id, "title": todo.title}
|
|
747
|
+
return todos_db[todo_id]
|
|
748
|
+
|
|
749
|
+
@app.get("/todos")
|
|
750
|
+
def get_todos():
|
|
751
|
+
"""@CODE:TODO-001:API - GET all endpoint"""
|
|
752
|
+
return list(todos_db.values())
|
|
753
|
+
|
|
754
|
+
@app.get("/todos/{todo_id}")
|
|
755
|
+
def get_todo(todo_id: str):
|
|
756
|
+
"""@CODE:TODO-001:API - GET by ID endpoint"""
|
|
757
|
+
if todo_id not in todos_db:
|
|
758
|
+
raise HTTPException(status_code=404, detail="Todo not found")
|
|
759
|
+
return todos_db[todo_id]
|
|
760
|
+
```
|
|
761
|
+
|
|
762
|
+
**Execute**: `pytest tests/test_todo_api.py -v`
|
|
763
|
+
**Result**: ✅ All pass!
|
|
764
|
+
|
|
765
|
+
**Git Commit**:
|
|
766
|
+
```bash
|
|
767
|
+
git commit -m "🟢 feat(TODO-001): implement minimal Todo API"
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
**♻️ REFACTOR: Code Improvement**
|
|
771
|
+
|
|
772
|
+
```python
|
|
773
|
+
# src/todo/models.py
|
|
774
|
+
# @CODE:TODO-001:MODEL | SPEC: SPEC-TODO-001.md
|
|
775
|
+
|
|
776
|
+
from datetime import datetime
|
|
777
|
+
from sqlalchemy import Column, String, DateTime
|
|
778
|
+
from sqlalchemy.ext.declarative import declarative_base
|
|
779
|
+
|
|
780
|
+
Base = declarative_base()
|
|
781
|
+
|
|
782
|
+
class Todo(Base):
|
|
783
|
+
"""@CODE:TODO-001:MODEL - Todo data model"""
|
|
784
|
+
__tablename__ = "todos"
|
|
785
|
+
|
|
786
|
+
id = Column(String, primary_key=True)
|
|
787
|
+
title = Column(String(200), nullable=False, index=True) # Constraint: max 200 chars
|
|
788
|
+
created_at = Column(DateTime, default=datetime.utcnow) # Auto creation time
|
|
789
|
+
|
|
790
|
+
def validate(self):
|
|
791
|
+
"""@CODE:TODO-001:MODEL - Validation"""
|
|
792
|
+
if not self.title or len(self.title) > 200:
|
|
793
|
+
raise ValueError("Title must be 1-200 characters")
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
**Execute**: `pytest tests/test_todo_api.py -v`
|
|
797
|
+
**Result**: ✅ Still all pass!
|
|
798
|
+
|
|
799
|
+
**Git Commit**:
|
|
800
|
+
```bash
|
|
801
|
+
git commit -m "♻️ refactor(TODO-001): add database models and validation"
|
|
802
|
+
```
|
|
803
|
+
|
|
804
|
+
**Phase 3: Quality Verification**
|
|
805
|
+
|
|
806
|
+
```bash
|
|
807
|
+
# TRUST verification
|
|
808
|
+
✅ Test First: 87% coverage
|
|
809
|
+
✅ Readable: All functions < 50 lines
|
|
810
|
+
✅ Unified: Consistent API patterns
|
|
811
|
+
✅ Secured: Input validation complete
|
|
812
|
+
✅ Trackable: All code has @TAG:TODO-001
|
|
813
|
+
```
|
|
814
|
+
|
|
815
|
+
### Step 3: SYNC - Documentation Sync (about 1 minute)
|
|
816
|
+
|
|
817
|
+
```bash
|
|
818
|
+
/alfred:3-sync
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
**Automatically Performed**:
|
|
822
|
+
|
|
823
|
+
1. **TAG Chain Validation**
|
|
824
|
+
```bash
|
|
825
|
+
✅ @SPEC:TODO-001 → .moai/specs/SPEC-TODO-001/spec.md
|
|
826
|
+
✅ @TEST:TODO-001 → tests/test_todo_api.py
|
|
827
|
+
✅ @CODE:TODO-001 → src/todo/ (3 files)
|
|
828
|
+
✅ @DOC:TODO-001 → docs/api/todo.md (auto-generated)
|
|
829
|
+
|
|
830
|
+
TAG Chain Integrity: 100%
|
|
831
|
+
Orphan TAGs: None
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
2. **Living Document Generation**
|
|
835
|
+
```markdown
|
|
836
|
+
# @DOC:TODO-001: Todo Management API
|
|
837
|
+
|
|
838
|
+
## Overview
|
|
839
|
+
REST API for managing tasks with CRUD operations.
|
|
840
|
+
|
|
841
|
+
## Endpoints
|
|
842
|
+
|
|
843
|
+
### Create Todo
|
|
844
|
+
- Method: POST
|
|
845
|
+
- URL: /todos
|
|
846
|
+
- Request: {"title": "string (1-200 chars)"}
|
|
847
|
+
- Response: 201 Created with todo object
|
|
848
|
+
- Implemented in: @CODE:TODO-001:API
|
|
849
|
+
- Tested in: @TEST:TODO-001
|
|
850
|
+
|
|
851
|
+
### Get All Todos
|
|
852
|
+
- Method: GET
|
|
853
|
+
- URL: /todos
|
|
854
|
+
- Response: 200 OK with array of todos
|
|
855
|
+
|
|
856
|
+
[... etc ...]
|
|
857
|
+
```
|
|
858
|
+
|
|
859
|
+
3. **README Update**
|
|
860
|
+
```markdown
|
|
861
|
+
## Features
|
|
862
|
+
|
|
863
|
+
- ✅ Todo Management API (TODO-001)
|
|
864
|
+
```
|
|
865
|
+
|
|
866
|
+
4. **CHANGELOG Generation**
|
|
867
|
+
```markdown
|
|
868
|
+
# Changelog
|
|
869
|
+
|
|
870
|
+
## [0.1.0] - 2025-10-22
|
|
871
|
+
|
|
872
|
+
### Added
|
|
873
|
+
- Todo Management API with CRUD operations (@SPEC:TODO-001)
|
|
874
|
+
- Create new todos
|
|
875
|
+
- List all todos
|
|
876
|
+
- Update existing todos
|
|
877
|
+
- Delete todos
|
|
878
|
+
|
|
879
|
+
### Implementation Details
|
|
880
|
+
- SPEC: .moai/specs/SPEC-TODO-001/spec.md
|
|
881
|
+
- Tests: tests/test_todo_api.py (87% coverage)
|
|
882
|
+
- Code: src/todo/ with models, API, repository layers
|
|
883
|
+
```
|
|
884
|
+
|
|
885
|
+
### Step 4: Verification (about 1 minute)
|
|
886
|
+
|
|
887
|
+
Let's verify everything generated is properly connected:
|
|
888
|
+
|
|
889
|
+
```bash
|
|
890
|
+
# 1️⃣ Check TAG chain
|
|
891
|
+
rg '@(SPEC|TEST|CODE|DOC):TODO-001' -n
|
|
892
|
+
|
|
893
|
+
# Output:
|
|
894
|
+
# .moai/specs/SPEC-TODO-001/spec.md:1: # @SPEC:TODO-001: Todo Management API
|
|
895
|
+
# tests/test_todo_api.py:2: # @TEST:TODO-001 | SPEC: SPEC-TODO-001.md
|
|
896
|
+
# src/todo/api.py:5: # @CODE:TODO-001:API | SPEC: SPEC-TODO-001.md
|
|
897
|
+
# src/todo/models.py:5: # @CODE:TODO-001:MODEL | SPEC: SPEC-TODO-001.md
|
|
898
|
+
# docs/api/todo.md:1: # @DOC:TODO-001: Todo Management API
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
# 2️⃣ Run tests
|
|
902
|
+
pytest tests/test_todo_api.py -v
|
|
903
|
+
# ✅ test_create_todo_should_return_201_with_todo_id PASSED
|
|
904
|
+
# ✅ test_get_todos_should_return_all_todos PASSED
|
|
905
|
+
# ✅ test_get_todo_with_invalid_id_should_return_404 PASSED
|
|
906
|
+
# ✅ 3 passed in 0.05s
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
# 3️⃣ Check generated documentation
|
|
910
|
+
cat docs/api/todo.md # API documentation auto-generated
|
|
911
|
+
cat README.md # Todo API added
|
|
912
|
+
cat CHANGELOG.md # Change history recorded
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
# 4️⃣ Check Git history
|
|
916
|
+
git log --oneline | head -5
|
|
917
|
+
# a1b2c3d ✅ sync(TODO-001): update docs and changelog
|
|
918
|
+
# f4e5d6c ♻️ refactor(TODO-001): add database models
|
|
919
|
+
# 7g8h9i0 🟢 feat(TODO-001): implement minimal API
|
|
920
|
+
# 1j2k3l4 🔴 test(TODO-001): add failing tests
|
|
921
|
+
# 5m6n7o8 🌿 Create feature/spec-todo-001 branch
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### After 15 Minutes: Complete System
|
|
925
|
+
|
|
926
|
+
```
|
|
927
|
+
✅ SPEC written (3 minutes)
|
|
928
|
+
└─ @SPEC:TODO-001 TAG assigned
|
|
929
|
+
└─ Clear requirements in EARS format
|
|
930
|
+
|
|
931
|
+
✅ TDD implementation (5 minutes)
|
|
932
|
+
└─ 🔴 RED: Tests written first
|
|
933
|
+
└─ 🟢 GREEN: Minimal implementation
|
|
934
|
+
└─ ♻️ REFACTOR: Quality improvement
|
|
935
|
+
└─ @TEST:TODO-001, @CODE:TODO-001 TAGs assigned
|
|
936
|
+
└─ 87% coverage, TRUST 5 principles verified
|
|
937
|
+
|
|
938
|
+
✅ Documentation sync (1 minute)
|
|
939
|
+
└─ Living Document auto-generated
|
|
940
|
+
└─ README, CHANGELOG updated
|
|
941
|
+
└─ TAG chain validation complete
|
|
942
|
+
└─ @DOC:TODO-001 TAG assigned
|
|
943
|
+
└─ PR status: Draft → Ready for Review
|
|
944
|
+
|
|
945
|
+
Result:
|
|
946
|
+
- 📋 Clear SPEC (SPEC-TODO-001.md)
|
|
947
|
+
- 🧪 85%+ test coverage (test_todo_api.py)
|
|
948
|
+
- 💎 Production-quality code (src/todo/)
|
|
949
|
+
- 📖 Auto-generated API documentation (docs/api/todo.md)
|
|
950
|
+
- 📝 Change history tracking (CHANGELOG.md)
|
|
951
|
+
- 🔗 Everything connected with TAGs
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
> **This is MoAI-ADK's true power.** Not just a simple API implementation,
|
|
955
|
+
> but a **complete development artifact** with everything from SPEC through tests, code, and documentation consistently connected!
|
|
956
|
+
|
|
957
|
+
---
|
|
958
|
+
|
|
959
|
+
## Sub-agents & Skills Overview
|
|
960
|
+
|
|
961
|
+
Alfred works by combining **19 agents** (1 SuperAgent + 10 Core Sub-agents + 6 0-project Sub-agents + 2 Built-in) with **56 Claude Skills**.
|
|
962
|
+
|
|
963
|
+
### Core Sub-agents (Plan → Run → Sync)
|
|
964
|
+
|
|
965
|
+
| Sub-agent | Model | Role |
|
|
966
|
+
| --- | --- | --- |
|
|
967
|
+
| project-manager 📋 | Sonnet | Project initialization, metadata interviews |
|
|
968
|
+
| spec-builder 🏗️ | Sonnet | Plan board, EARS SPEC authoring |
|
|
969
|
+
| code-builder 💎 | Sonnet | Performs complete TDD with `implementation-planner` + `tdd-implementer` |
|
|
970
|
+
| doc-syncer 📖 | Haiku | Living Doc, README, CHANGELOG sync |
|
|
971
|
+
| tag-agent 🏷️ | Haiku | TAG inventory, orphan detection |
|
|
972
|
+
| git-manager 🚀 | Haiku | GitFlow, Draft/Ready, Auto Merge |
|
|
973
|
+
| debug-helper 🔍 | Sonnet | Failure analysis, fix-forward strategy |
|
|
974
|
+
| trust-checker ✅ | Haiku | TRUST 5 quality gate |
|
|
975
|
+
| quality-gate 🛡️ | Haiku | Coverage change and release blocker review |
|
|
976
|
+
| cc-manager 🛠️ | Sonnet | Claude Code session optimization, Skill deployment |
|
|
977
|
+
|
|
978
|
+
### Skills (Progressive Disclosure - v0.4 New!)
|
|
979
|
+
|
|
980
|
+
Alfred organizes **56 Claude Skills** in a 4-tier architecture using **Progressive Disclosure** to load Just-In-Time only when needed. Each Skill is a production-grade guide of 1,000+ lines stored in `.claude/skills/` directory.
|
|
981
|
+
|
|
982
|
+
#### Foundation Tier (6)
|
|
983
|
+
Core skills containing fundamental TRUST/TAG/SPEC/Git/EARS/Language principles
|
|
984
|
+
|
|
985
|
+
| Skill | Description |
|
|
986
|
+
| --- | --- |
|
|
987
|
+
| `moai-foundation-trust` | TRUST 5-principles (Test 85%+, Readable, Unified, Secured, Trackable) verification |
|
|
988
|
+
| `moai-foundation-tags` | @TAG markers scan and inventory generation (CODE-FIRST principle) |
|
|
989
|
+
| `moai-foundation-specs` | SPEC YAML frontmatter (7 required fields) and HISTORY section validation |
|
|
990
|
+
| `moai-foundation-ears` | EARS (Easy Approach to Requirements Syntax) requirements writing guide |
|
|
991
|
+
| `moai-foundation-git` | Git workflow automation (branching, TDD commits, PR management) |
|
|
992
|
+
| `moai-foundation-langs` | Project language/framework auto-detection (package.json, pyproject.toml, etc.) |
|
|
993
|
+
|
|
994
|
+
#### Essentials Tier (4)
|
|
995
|
+
Core tools needed for daily development work
|
|
996
|
+
|
|
997
|
+
| Skill | Description |
|
|
998
|
+
| --- | --- |
|
|
999
|
+
| `moai-essentials-debug` | Stack trace analysis, error pattern detection, quick diagnosis support |
|
|
1000
|
+
| `moai-essentials-perf` | Performance profiling, bottleneck detection, tuning strategies |
|
|
1001
|
+
| `moai-essentials-refactor` | Refactoring guide, design patterns, code improvement strategies |
|
|
1002
|
+
| `moai-essentials-review` | Automated code review, SOLID principles, code smell detection |
|
|
1003
|
+
|
|
1004
|
+
#### Alfred Tier (11)
|
|
1005
|
+
MoAI-ADK internal workflow orchestration skills
|
|
1006
|
+
|
|
1007
|
+
| Skill | Description |
|
|
1008
|
+
| --- | --- |
|
|
1009
|
+
| `moai-alfred-code-reviewer` | Automated code review with language-specific best practices, SOLID principles, improvement suggestions |
|
|
1010
|
+
| `moai-alfred-debugger-pro` | Stack trace analysis, error pattern detection, complex runtime error interpretation |
|
|
1011
|
+
| `moai-alfred-ears-authoring` | EARS syntax validation, 5 requirement pattern guide |
|
|
1012
|
+
| `moai-alfred-git-workflow` | MoAI-ADK conventions (feature branch, TDD commits, Draft PR) automation |
|
|
1013
|
+
| `moai-alfred-language-detection` | Project language/runtime detection, default test tool recommendations |
|
|
1014
|
+
| `moai-alfred-performance-optimizer` | Performance profiling, bottleneck detection, language-specific optimization |
|
|
1015
|
+
| `moai-alfred-refactoring-coach` | Refactoring guide, design patterns, step-by-step improvement plan |
|
|
1016
|
+
| `moai-alfred-spec-metadata-validation` | SPEC YAML frontmatter (7 fields) and HISTORY section consistency validation |
|
|
1017
|
+
| `moai-alfred-tag-scanning` | Complete @TAG marker scan and inventory generation (CODE-FIRST principle) |
|
|
1018
|
+
| `moai-alfred-trust-validation` | TRUST 5-principles compliance verification (Test 85%+, constraints, security, trackability) |
|
|
1019
|
+
| `moai-alfred-tui-survey` | Claude Code Tools AskUserQuestion TUI menu standardization |
|
|
1020
|
+
|
|
1021
|
+
#### Domain Tier (10)
|
|
1022
|
+
Specialized domain expertise
|
|
1023
|
+
|
|
1024
|
+
| Skill | Description |
|
|
1025
|
+
| --- | --- |
|
|
1026
|
+
| `moai-domain-backend` | Backend architecture, API design, scaling guide |
|
|
1027
|
+
| `moai-domain-cli-tool` | CLI tool development, argument parsing, POSIX compliance, user-friendly help messages |
|
|
1028
|
+
| `moai-domain-data-science` | Data analysis, visualization, statistical modeling, reproducible research workflows |
|
|
1029
|
+
| `moai-domain-database` | Database design, schema optimization, indexing strategies, migration management |
|
|
1030
|
+
| `moai-domain-devops` | CI/CD pipelines, Docker containerization, Kubernetes orchestration, IaC |
|
|
1031
|
+
| `moai-domain-frontend` | React/Vue/Angular development, state management, performance optimization, accessibility |
|
|
1032
|
+
| `moai-domain-ml` | Machine learning model training, evaluation, deployment, MLOps workflows |
|
|
1033
|
+
| `moai-domain-mobile-app` | Flutter/React Native development, state management, native integration |
|
|
1034
|
+
| `moai-domain-security` | OWASP Top 10, static analysis (SAST), dependency security, secrets management |
|
|
1035
|
+
| `moai-domain-web-api` | REST API, GraphQL design patterns, authentication, versioning, OpenAPI documentation |
|
|
1036
|
+
|
|
1037
|
+
#### Language Tier (24)
|
|
1038
|
+
Programming language-specific best practices
|
|
1039
|
+
|
|
1040
|
+
| Skill | Description |
|
|
1041
|
+
| --- | --- |
|
|
1042
|
+
| `moai-lang-python` | pytest, mypy, ruff, black, uv package management |
|
|
1043
|
+
| `moai-lang-typescript` | Vitest, Biome, strict typing, npm/pnpm |
|
|
1044
|
+
| `moai-lang-javascript` | Jest, ESLint, Prettier, npm package management |
|
|
1045
|
+
| `moai-lang-go` | go test, golint, gofmt, standard library |
|
|
1046
|
+
| `moai-lang-rust` | cargo test, clippy, rustfmt, ownership/borrow checker |
|
|
1047
|
+
| `moai-lang-java` | JUnit, Maven/Gradle, Checkstyle, Spring Boot patterns |
|
|
1048
|
+
| `moai-lang-kotlin` | JUnit, Gradle, ktlint, coroutines, extension functions |
|
|
1049
|
+
| `moai-lang-swift` | XCTest, SwiftLint, iOS/macOS development patterns |
|
|
1050
|
+
| `moai-lang-dart` | flutter test, dart analyze, Flutter widget patterns |
|
|
1051
|
+
| `moai-lang-csharp` | xUnit, .NET tooling, LINQ, async/await patterns |
|
|
1052
|
+
| `moai-lang-cpp` | Google Test, clang-format, modern C++ (C++17/20) |
|
|
1053
|
+
| `moai-lang-c` | Unity test framework, cppcheck, Make build system |
|
|
1054
|
+
| `moai-lang-scala` | ScalaTest, sbt, functional programming patterns |
|
|
1055
|
+
| `moai-lang-ruby` | RSpec, RuboCop, Bundler, Rails patterns |
|
|
1056
|
+
| `moai-lang-php` | PHPUnit, Composer, PSR standards |
|
|
1057
|
+
| `moai-lang-sql` | Test frameworks, query optimization, migration management |
|
|
1058
|
+
| `moai-lang-shell` | bats, shellcheck, POSIX compliance |
|
|
1059
|
+
| `moai-lang-haskell` | HUnit, Stack/Cabal, pure functional programming |
|
|
1060
|
+
| `moai-lang-elixir` | ExUnit, Mix, OTP patterns |
|
|
1061
|
+
| `moai-lang-clojure` | clojure.test, Leiningen, immutable data structures |
|
|
1062
|
+
| `moai-lang-lua` | busted, luacheck, embedded scripting patterns |
|
|
1063
|
+
| `moai-lang-julia` | Test stdlib, Pkg manager, scientific computing patterns |
|
|
1064
|
+
| `moai-lang-r` | testthat, lintr, data analysis patterns |
|
|
1065
|
+
| `moai-lang-kotlin` | JUnit, Gradle, ktlint, coroutines, extension functions |
|
|
1066
|
+
|
|
1067
|
+
#### Claude Code Ops (1)
|
|
1068
|
+
Claude Code session management
|
|
1069
|
+
|
|
1070
|
+
| Skill | Description |
|
|
1071
|
+
| --- | --- |
|
|
1072
|
+
| `moai-claude-code` | Claude Code agents, commands, skills, plugins, settings scaffolding and monitoring |
|
|
1073
|
+
|
|
1074
|
+
> **v0.4.6 New Feature**: 56 Claude Skills organized in 4-tier architecture (100% complete in v0.4.6). Each Skill loads via Progressive Disclosure only when needed to minimize context cost. Organized in Foundation → Essentials → Alfred → Domain/Language/Ops tiers, with all skills including 1,000+ lines of official documentation and 300+ executable TDD examples.
|
|
1075
|
+
|
|
1076
|
+
---
|
|
1077
|
+
|
|
1078
|
+
## AI Model Selection Guide
|
|
1079
|
+
|
|
1080
|
+
| Scenario | Default Model | Why |
|
|
1081
|
+
| --- | --- | --- |
|
|
1082
|
+
| Specifications, design, refactoring, problem solving | **Claude 4.5 Sonnet** | Strong in deep reasoning and structured writing |
|
|
1083
|
+
| Document sync, TAG checks, Git automation | **Claude 4.5 Haiku** | Strong in rapid iteration, string processing |
|
|
1084
|
+
|
|
1085
|
+
- Start with Haiku for patterned tasks; switch to Sonnet when complex judgment is needed.
|
|
1086
|
+
- If you manually change models, noting "why switched" in logs helps collaboration.
|
|
1087
|
+
|
|
1088
|
+
---
|
|
1089
|
+
|
|
1090
|
+
## Frequently Asked Questions (FAQ)
|
|
1091
|
+
|
|
1092
|
+
- **Q. Can I install on an existing project?**
|
|
1093
|
+
- A. Yes. Run `moai-adk init .` to add only the `.moai/` structure without touching existing code.
|
|
1094
|
+
- **Q. How do I run tests?**
|
|
1095
|
+
- A. `/alfred:2-run` runs them first; rerun `pytest`, `pnpm test`, etc. per language as needed.
|
|
1096
|
+
- **Q. How do I ensure documentation stays current?**
|
|
1097
|
+
- A. `/alfred:3-sync` generates a Sync Report. Check the report in Pull Requests.
|
|
1098
|
+
- **Q. Can I work manually?**
|
|
1099
|
+
- A. Yes, but keep the SPEC → TEST → CODE → DOC order and always leave TAGs.
|
|
1100
|
+
|
|
1101
|
+
---
|
|
1102
|
+
|
|
1103
|
+
## v0.4 Series Updates (New!)
|
|
1104
|
+
|
|
1105
|
+
| Version | Key Features | Date |
|
|
1106
|
+
| --- | --- | --- |
|
|
1107
|
+
| **v0.4.6** | 🎉 Complete Skills v2.0 (56/56 100%) + 85,000 lines official docs + 300+ TDD examples | 2025-10-22 |
|
|
1108
|
+
| **v0.4.5** | ✅ CI/CD fixes + Multi-language README + Deployment cleanup | 2025-10-22 |
|
|
1109
|
+
| **v0.4.4** | Korean language support | 2025-10-21 |
|
|
1110
|
+
| **v0.4.3** | Interactive question tool (TUI menu) | 2025-10-21 |
|
|
1111
|
+
| **v0.4.1** | Skills localization | 2025-10-21 |
|
|
1112
|
+
| **v0.4.0** | **56 Claude Skills** + 19-member AI team + 4-stage workflow | 2025-10-21 |
|
|
1113
|
+
|
|
1114
|
+
> 📦 **Install Now**: `pip install moai-adk==0.4.6` or `uv tool install moai-adk==0.4.6`
|
|
1115
|
+
|
|
1116
|
+
---
|
|
1117
|
+
|
|
1118
|
+
## Additional Resources
|
|
1119
|
+
|
|
1120
|
+
| Purpose | Resource |
|
|
1121
|
+
| --- | --- |
|
|
1122
|
+
| Skills detailed structure | `.claude/skills/` directory (56 Skills) |
|
|
1123
|
+
| Sub-agent details | `.claude/agents/alfred/` directory |
|
|
1124
|
+
| Workflow guide | `.claude/commands/alfred/` (0-3 commands) |
|
|
1125
|
+
| Development guidelines | `.moai/memory/development-guide.md`, `.moai/memory/spec-metadata.md` |
|
|
1126
|
+
| Release notes | GitHub Releases: https://github.com/modu-ai/moai-adk/releases |
|
|
1127
|
+
|
|
1128
|
+
---
|
|
1129
|
+
|
|
1130
|
+
## Community & Support
|
|
1131
|
+
|
|
1132
|
+
| Channel | Link |
|
|
1133
|
+
| --- | --- |
|
|
1134
|
+
| **GitHub Repository** | https://github.com/modu-ai/moai-adk |
|
|
1135
|
+
| **Issues & Discussions** | https://github.com/modu-ai/moai-adk/issues |
|
|
1136
|
+
| **PyPI Package** | https://pypi.org/project/moai-adk/ (Latest: v0.4.6) |
|
|
1137
|
+
| **Latest Release** | https://github.com/modu-ai/moai-adk/releases/tag/v0.4.6 |
|
|
1138
|
+
| **Documentation** | See `.moai/`, `.claude/`, `docs/` within project |
|
|
1139
|
+
|
|
1140
|
+
---
|
|
1141
|
+
|
|
1142
|
+
## 🚀 MoAI-ADK Philosophy
|
|
1143
|
+
|
|
1144
|
+
> **"No CODE without SPEC"**
|
|
1145
|
+
|
|
1146
|
+
MoAI-ADK is not simply a code generation tool. Alfred SuperAgent with its 19-member team and 56 Claude Skills together guarantee:
|
|
1147
|
+
|
|
1148
|
+
- ✅ **SPEC → TEST (TDD) → CODE → DOCS consistency**
|
|
1149
|
+
- ✅ **Complete history tracking with @TAG system**
|
|
1150
|
+
- ✅ **Guaranteed 87.84%+ coverage**
|
|
1151
|
+
- ✅ **Iterative development with 4-stage workflow (0-project → 1-plan → 2-run → 3-sync)**
|
|
1152
|
+
- ✅ **Collaborate with AI transparently and traceably**
|
|
1153
|
+
|
|
1154
|
+
Start a new experience of **trustworthy AI development** with Alfred! 🤖
|
|
1155
|
+
|
|
1156
|
+
---
|
|
1157
|
+
|
|
1158
|
+
**MoAI-ADK v0.4.6** — SPEC-First TDD with AI SuperAgent & Complete Skills v2.0
|
|
1159
|
+
- 📦 PyPI: https://pypi.org/project/moai-adk/
|
|
1160
|
+
- 🏠 GitHub: https://github.com/modu-ai/moai-adk
|
|
1161
|
+
- 📝 License: MIT
|
|
1162
|
+
- ⭐ Skills: 56/56 Complete (100% Production-Ready)
|