the-frame-ai 0.2.0 → 0.3.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/README.de.md +335 -0
- package/README.es.md +335 -0
- package/README.hi.md +335 -0
- package/README.ja.md +335 -0
- package/README.md +1 -1
- package/README.ru.md +1 -1
- package/README.zh.md +335 -0
- package/package.json +3 -3
- package/src/cli.js +5 -1
- package/src/init.js +20 -2
- package/src/languages.js +11 -0
- package/src/update.js +28 -9
- package/src/utils.js +10 -0
package/README.hi.md
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
# THE Frame
|
|
2
|
+
|
|
3
|
+
FRAME — AI-सहायता प्राप्त एकल विकास के लिए फ्रेमवर्क
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇨🇳 中文](README.zh.md) | [🇮🇳 हिंदी](README.hi.md) | [🇯🇵 日本語](README.ja.md) | [🇩🇪 Deutsch](README.de.md) | [🇪🇸 Español](README.es.md) | [🇷🇺 Русский](README.ru.md)
|
|
6
|
+
|
|
7
|
+
## FRAME क्या है?
|
|
8
|
+
|
|
9
|
+
**FRAME (Framework for AI-Assisted Solo Development)** Claude Code के साथ उत्पाद बनाने वाले एकल डेवलपर्स के लिए एक फ्रेमवर्क है। यह अव्यवस्थित AI-सहायता प्राप्त विकास को एक पूर्वानुमानित प्रक्रिया में बदलता है — विचार से लेकर डिप्लॉय तक — मेमोरी, संरचना और गलतियों से सुरक्षा के साथ।
|
|
10
|
+
|
|
11
|
+
यदि आप Claude Code के साथ अकेले कोई उत्पाद बना रहे हैं और एक टीम की तरह काम करना चाहते हैं — FRAME आपके लिए है।
|
|
12
|
+
|
|
13
|
+
## FRAME कौन सी समस्याएं हल करता है?
|
|
14
|
+
|
|
15
|
+
| समस्या | FRAME क्या प्रदान करता है |
|
|
16
|
+
|--------|--------------------------|
|
|
17
|
+
| सत्रों के बीच संदर्भ खोना | प्रोजेक्ट मेमोरी और सत्र शुरू होने पर स्वचालित स्थिति डंप |
|
|
18
|
+
| कार्यों और प्राथमिकताओं में अव्यवस्था | 6-चरण वर्कफ़्लो: अनुसंधान → योजना → निर्माण → समीक्षा → शिप → प्रतिबिंब |
|
|
19
|
+
| कुछ महत्वपूर्ण तोड़ने का डर | सेफ्टी हुक्स विनाशकारी कमांड को चलने से पहले ब्लॉक करते हैं |
|
|
20
|
+
| दोहराव वाले नियमित कार्य | पूर्ण विकास चक्र के लिए 34 तैयार कमांड |
|
|
21
|
+
| निर्भरताओं वाली जटिल सुविधाएं | स्वतंत्र कार्यों के लिए समानांतर सब-एजेंट |
|
|
22
|
+
| एकल कार्य के लिए कोई संरचना नहीं | Roadmap, STATE.md, MAP.md — हमेशा जानें आप कहां हैं और आगे क्या है |
|
|
23
|
+
|
|
24
|
+
## FRAME के साथ कैसे काम करें
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
अनुसंधान → योजना → निर्माण → समीक्षा → शिप → प्रतिबिंब
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
प्रत्येक सत्र एक चक्र है। `/frame:daily` से शुरू करें, `/frame:ship` के साथ समाप्त करें।
|
|
31
|
+
|
|
32
|
+
**अनुसंधान** — बनाने से पहले समझें
|
|
33
|
+
`/frame:research <विषय>` चलाएं — Claude कोडबेस, बाहरी स्रोतों का पता लगाता है और अगले चरण के लिए संदर्भ बनाता है।
|
|
34
|
+
|
|
35
|
+
**योजना** — कार्यों में विभाजित करें
|
|
36
|
+
`/frame:plan <सुविधा>` अनुसंधान को अनुमानों के साथ एक ठोस कार्य सूची में बदलता है।
|
|
37
|
+
|
|
38
|
+
**निर्माण** — लागू करें
|
|
39
|
+
`/frame:build` TDD के साथ क्रमिक रूप से कार्य निष्पादित करता है (एक बार में 1–3)। कई स्वतंत्र कार्यों के लिए — `/frame:wave` उन्हें समानांतर बैचों में चलाता है। अटक गए — `/frame:unstuck`। बग मिला — `/frame:debug`।
|
|
40
|
+
|
|
41
|
+
**समीक्षा** — डिप्लॉय करने से पहले जांचें
|
|
42
|
+
`/frame:review` स्वचालित जांच चलाता है और एक चेकलिस्ट देता है: परीक्षण, प्रकार, सुरक्षा, प्रदर्शन।
|
|
43
|
+
|
|
44
|
+
**शिप** — डिप्लॉय करें और रिकॉर्ड करें
|
|
45
|
+
`/frame:ship` कमिट करता है, वैकल्पिक पुश/PR, और प्रोजेक्ट मेमोरी अपडेट करता है।
|
|
46
|
+
|
|
47
|
+
**प्रतिबिंब** — सीखें और सुधारें
|
|
48
|
+
डिप्लॉय के बाद `/frame:retrospective` मेट्रिक्स अपडेट करता है और भविष्य के सत्रों के लिए पैटर्न कैप्चर करता है।
|
|
49
|
+
|
|
50
|
+
## उदाहरण
|
|
51
|
+
|
|
52
|
+
### नई सुविधा: Google प्रमाणीकरण जोड़ें
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
/frame:daily
|
|
56
|
+
# → वर्तमान प्रोजेक्ट स्थिति और क्या योजना है देखें
|
|
57
|
+
|
|
58
|
+
/frame:research "Google OAuth"
|
|
59
|
+
# → Claude कोडबेस का अध्ययन करता है: वर्तमान auth कैसे काम करता है,
|
|
60
|
+
# कौन से पैटर्न पहले से उपयोग किए जा रहे हैं, क्या जोड़ना है
|
|
61
|
+
|
|
62
|
+
/frame:plan "Google OAuth"
|
|
63
|
+
# → एक ठोस कार्य सूची प्राप्त करें:
|
|
64
|
+
# 1. Google OAuth क्रेडेंशियल कॉन्फ़िगर करें
|
|
65
|
+
# 2. कॉलबैक रूट जोड़ें
|
|
66
|
+
# 3. सत्रों से कनेक्ट करें
|
|
67
|
+
# 4. UI में बटन जोड़ें
|
|
68
|
+
|
|
69
|
+
/frame:checkpoint
|
|
70
|
+
# → एक रिस्टोर पॉइंट सेव करें — अगर कुछ गलत हो जाए, तो रोलबैक कर सकते हैं
|
|
71
|
+
|
|
72
|
+
/frame:wave
|
|
73
|
+
# → कार्य 1–4 स्वतंत्र हैं, Claude उन्हें समानांतर में चलाता है
|
|
74
|
+
|
|
75
|
+
/frame:review
|
|
76
|
+
# → स्वचालित जांच: परीक्षण, प्रकार, सुरक्षा
|
|
77
|
+
|
|
78
|
+
/frame:ship
|
|
79
|
+
# → कमिट, वैकल्पिक पुश/PR, प्रोजेक्ट मेमोरी अपडेट
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### बग: पासवर्ड रीसेट के बाद उपयोगकर्ता लॉग इन नहीं कर सकते
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
/frame:daily
|
|
86
|
+
# → संदर्भ पुनर्स्थापित करें, देखें कि बग पहले से योजना में है या इसे जोड़ें
|
|
87
|
+
|
|
88
|
+
/frame:debug "login after reset"
|
|
89
|
+
# → Claude व्यवस्थित रूप से जांचता है: लॉग, रीसेट फ्लो, सत्र, टोकन
|
|
90
|
+
# → आपको कोड में एक विशिष्ट स्थान के साथ एक परिकल्पना मिलती है
|
|
91
|
+
|
|
92
|
+
# यदि कारण तुरंत मिल जाए:
|
|
93
|
+
/frame:checkpoint # फिक्स से पहले रिस्टोर पॉइंट
|
|
94
|
+
/frame:fast "fix: invalidate old session after password reset"
|
|
95
|
+
# → Claude एक लक्षित फिक्स करता है, एक रिग्रेशन टेस्ट लिखता है
|
|
96
|
+
|
|
97
|
+
# यदि कारण अस्पष्ट हो — गहराई में जाएं:
|
|
98
|
+
/frame:forensics
|
|
99
|
+
# → इस क्षेत्र में परिवर्तनों के git इतिहास का विश्लेषण करता है,
|
|
100
|
+
# वह कमिट ढूंढता है जिसने व्यवहार तोड़ा
|
|
101
|
+
|
|
102
|
+
/frame:checkpoint
|
|
103
|
+
/frame:fast "fix: ..." # मिले कारण को ठीक करें
|
|
104
|
+
|
|
105
|
+
/frame:review
|
|
106
|
+
# → पुष्टि करें कि फिक्स ने अन्य लॉगिन परिदृश्यों को नहीं तोड़ा
|
|
107
|
+
|
|
108
|
+
/frame:ship
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### सुधार: डैशबोर्ड लोडिंग तेज करें
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
/frame:daily
|
|
115
|
+
|
|
116
|
+
/frame:performance
|
|
117
|
+
# → बेसलाइन प्राप्त करें: bundle आकार, लोड समय, Lighthouse स्कोर
|
|
118
|
+
# संख्याएं याद रखें — अंत में तुलना के लिए चाहिए होंगी
|
|
119
|
+
|
|
120
|
+
/frame:research "dashboard performance"
|
|
121
|
+
# → Claude डैशबोर्ड कोड का विश्लेषण करता है: भारी कंपोनेंट,
|
|
122
|
+
# अनावश्यक अनुरोध, क्या कैश या lazy-load किया जा सकता है
|
|
123
|
+
|
|
124
|
+
/frame:plan "dashboard optimization"
|
|
125
|
+
# → प्रभाव अनुमानों के साथ कार्य सूची:
|
|
126
|
+
# 1. भारी चार्ट को lazy load करें
|
|
127
|
+
# 2. API अनुरोधों को कैश करें
|
|
128
|
+
# 3. माउंट पर डुप्लिकेट अनुरोध हटाएं
|
|
129
|
+
|
|
130
|
+
/frame:build
|
|
131
|
+
# → क्रमिक, प्रत्येक कार्य एक परीक्षण के साथ
|
|
132
|
+
|
|
133
|
+
/frame:performance
|
|
134
|
+
# → बेसलाइन से तुलना करें: वास्तविक सुधार देखें
|
|
135
|
+
|
|
136
|
+
/frame:ship
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## अंदर क्या है
|
|
140
|
+
|
|
141
|
+
FRAME प्रदान करता है:
|
|
142
|
+
|
|
143
|
+
- **6-चरण वर्कफ़्लो**: अनुसंधान → योजना → निर्माण → समीक्षा → शिप → प्रतिबिंब
|
|
144
|
+
- **34 कमांड**: त्वरित कार्यों से लेकर पूर्ण सुविधा विकास चक्र तक
|
|
145
|
+
- **5 AI एजेंट**: शोधकर्ता, योजनाकार, निर्माता, समीक्षक, शैतान का वकील
|
|
146
|
+
- **सेफ्टी हुक्स**: विनाशकारी ऑपरेशन ब्लॉक करते हैं, गुणवत्ता गेट लागू करते हैं
|
|
147
|
+
- **Git सुरक्षा**: चेकपॉइंट, रोलबैक, वर्कट्री, पॉज/रिज्यूम
|
|
148
|
+
|
|
149
|
+
## पूर्वापेक्षाएं
|
|
150
|
+
|
|
151
|
+
- Node.js >= 18
|
|
152
|
+
- Git (प्रोजेक्ट एक git रिपॉजिटरी होनी चाहिए)
|
|
153
|
+
|
|
154
|
+
## त्वरित शुरुआत
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
# यदि आवश्यक हो तो git रेपो इनिशियलाइज़ करें
|
|
158
|
+
git init && git commit --allow-empty -m "init"
|
|
159
|
+
|
|
160
|
+
# FRAME इंस्टॉल करें
|
|
161
|
+
npx the-frame-ai init
|
|
162
|
+
|
|
163
|
+
# इस प्रोजेक्ट में Claude Code खोलें और चलाएं:
|
|
164
|
+
/frame:init # कोडबेस स्कैन करता है, MAP.md भरता है
|
|
165
|
+
/frame:daily # हर दिन आपका प्रवेश बिंदु
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## कमांड
|
|
169
|
+
|
|
170
|
+
### कोर — यहां से शुरू करें
|
|
171
|
+
|
|
172
|
+
ये 7 कमांड एकल dev कार्य का 90% कवर करते हैं:
|
|
173
|
+
|
|
174
|
+
| कमांड | कब उपयोग करें |
|
|
175
|
+
|-------|--------------|
|
|
176
|
+
| `/frame:daily` | किसी भी ब्रेक के बाद **यहां से शुरू करें** — क्या हुआ, आगे क्या है |
|
|
177
|
+
| `/frame:research <विषय>` | नई सुविधा की योजना बनाने से पहले |
|
|
178
|
+
| `/frame:plan <सुविधा>` | अनुसंधान को एक कार्ययोग्य कार्य सूची में बदलें |
|
|
179
|
+
| `/frame:build` | TDD के साथ 1–3 कार्य लागू करें (क्रमिक) |
|
|
180
|
+
| `/frame:wave` | 4+ स्वतंत्र कार्य लागू करें (समानांतर सब-एजेंट) |
|
|
181
|
+
| `/frame:review` | डिप्लॉय करने से पहले — स्वचालित जांच + चेकलिस्ट |
|
|
182
|
+
| `/frame:ship` | कमिट, वैकल्पिक पुश/PR, मेमोरी अपडेट करें |
|
|
183
|
+
|
|
184
|
+
### चरण के अनुसार सभी कमांड
|
|
185
|
+
|
|
186
|
+
<details>
|
|
187
|
+
<summary>अनुसंधान</summary>
|
|
188
|
+
|
|
189
|
+
| कमांड | कब उपयोग करें |
|
|
190
|
+
|-------|--------------|
|
|
191
|
+
| `/frame:research <विषय>` | नई सुविधा की योजना बनाने से पहले |
|
|
192
|
+
| `/frame:explain <फ़ाइल>` | यह कोड ऐसा क्यों दिखता है? |
|
|
193
|
+
| `/frame:why <विषय>` | निर्णय इतिहास खोजें |
|
|
194
|
+
</details>
|
|
195
|
+
|
|
196
|
+
<details>
|
|
197
|
+
<summary>योजना</summary>
|
|
198
|
+
|
|
199
|
+
| कमांड | कब उपयोग करें |
|
|
200
|
+
|-------|--------------|
|
|
201
|
+
| `/frame:plan <सुविधा>` | अनुसंधान को एक कार्ययोग्य कार्य सूची में बदलें |
|
|
202
|
+
| `/frame:add-task` | काम बाधित किए बिना योजना में कार्य जोड़ें |
|
|
203
|
+
</details>
|
|
204
|
+
|
|
205
|
+
<details>
|
|
206
|
+
<summary>निर्माण</summary>
|
|
207
|
+
|
|
208
|
+
| कमांड | कब उपयोग करें |
|
|
209
|
+
|-------|--------------|
|
|
210
|
+
| `/frame:build` | TDD के साथ योजना लागू करें (1–3 कार्य, क्रमिक) |
|
|
211
|
+
| `/frame:wave` | समानांतर बैचों में 4+ स्वतंत्र कार्य लागू करें |
|
|
212
|
+
| `/frame:fast <कार्य>` | 30 मिनट से कम का त्वरित कार्य |
|
|
213
|
+
| `/frame:debug <समस्या>` | व्यवस्थित बग जांच |
|
|
214
|
+
| `/frame:forensics` | कुछ क्यों टूटा इसकी गहरी जांच |
|
|
215
|
+
| `/frame:refactor` | TDD सेफ्टी नेट के साथ रिफैक्टर |
|
|
216
|
+
| `/frame:migrate` | रोलबैक योजना के साथ DB/API/deps माइग्रेशन |
|
|
217
|
+
</details>
|
|
218
|
+
|
|
219
|
+
<details>
|
|
220
|
+
<summary>समीक्षा</summary>
|
|
221
|
+
|
|
222
|
+
| कमांड | कब उपयोग करें |
|
|
223
|
+
|-------|--------------|
|
|
224
|
+
| `/frame:review` | डिप्लॉय करने से पहले — स्वचालित जांच + चेकलिस्ट |
|
|
225
|
+
| `/frame:health` | पूर्ण प्रोजेक्ट स्वास्थ्य जांच |
|
|
226
|
+
| `/frame:check-deps` | सुरक्षा ऑडिट + पुराने पैकेज |
|
|
227
|
+
| `/frame:performance` | Bundle आकार और Lighthouse ऑडिट |
|
|
228
|
+
</details>
|
|
229
|
+
|
|
230
|
+
<details>
|
|
231
|
+
<summary>शिप</summary>
|
|
232
|
+
|
|
233
|
+
| कमांड | कब उपयोग करें |
|
|
234
|
+
|-------|--------------|
|
|
235
|
+
| `/frame:ship` | कमिट, वैकल्पिक पुश/PR, मेमोरी अपडेट करें |
|
|
236
|
+
| `/frame:checkpoint` | जोखिम भरे बदलाव से पहले git टैग सेव करें |
|
|
237
|
+
| `/frame:rollback` | चेकपॉइंट पर रोलबैक करें |
|
|
238
|
+
</details>
|
|
239
|
+
|
|
240
|
+
<details>
|
|
241
|
+
<summary>प्रतिबिंब</summary>
|
|
242
|
+
|
|
243
|
+
| कमांड | कब उपयोग करें |
|
|
244
|
+
|-------|--------------|
|
|
245
|
+
| `/frame:retrospective` | डिप्लॉय के बाद — मेमोरी और मेट्रिक्स अपडेट करें |
|
|
246
|
+
| `/frame:sprint-check` | रोडमैप के विरुद्ध साप्ताहिक प्रगति |
|
|
247
|
+
| `/frame:cleanup-memory` | पुरानी मेमोरी ट्रिम और आर्काइव करें |
|
|
248
|
+
</details>
|
|
249
|
+
|
|
250
|
+
<details>
|
|
251
|
+
<summary>दैनिक और उपयोगिताएं</summary>
|
|
252
|
+
|
|
253
|
+
| कमांड | कब उपयोग करें |
|
|
254
|
+
|-------|--------------|
|
|
255
|
+
| `/frame:daily` | दिन की शुरुआत — क्या हुआ, आगे क्या है |
|
|
256
|
+
| `/frame:status` | पूर्ण स्थिति डंप (git, मेमोरी, ब्लॉकर्स) |
|
|
257
|
+
| `/frame:note` | एक पैटर्न, निर्णय, या एंटी-पैटर्न कैप्चर करें |
|
|
258
|
+
| `/frame:unstuck` | अटक गए? अनब्लॉक करने के लिए 3 ठोस विकल्प प्राप्त करें |
|
|
259
|
+
| `/frame:context` | वर्तमान कार्य संदर्भ दिखाएं |
|
|
260
|
+
| `/frame:init` | पहली बार चलाएं — कोडबेस स्कैन करें, MAP.md भरें |
|
|
261
|
+
| `/frame:doctor` | FRAME इंस्टॉलेशन सत्यापित करें |
|
|
262
|
+
| `/frame:pause` / `/frame:resume` | मध्य-कार्य स्थिति सेव और पुनर्स्थापित करें |
|
|
263
|
+
</details>
|
|
264
|
+
|
|
265
|
+
<details>
|
|
266
|
+
<summary>उन्नत</summary>
|
|
267
|
+
|
|
268
|
+
| कमांड | कब उपयोग करें |
|
|
269
|
+
|-------|--------------|
|
|
270
|
+
| `/frame:worktree` | समानांतर प्रयोगों के लिए अलग git वर्कट्री |
|
|
271
|
+
| `/frame:headless` | स्वायत्त CI मोड (कोई इंटरैक्शन नहीं) |
|
|
272
|
+
| `/frame:estimate <कार्य>` | शुरू करने से पहले स्कोप और समय अनुमान |
|
|
273
|
+
</details>
|
|
274
|
+
|
|
275
|
+
## हुक्स
|
|
276
|
+
|
|
277
|
+
FRAME `.claude/hooks/` में 4 हुक्स इंस्टॉल करता है। वे स्वचालित रूप से चलते हैं।
|
|
278
|
+
|
|
279
|
+
| हुक | ट्रिगर | क्या करता है | अक्षम करने के लिए |
|
|
280
|
+
|-----|--------|-------------|-----------------|
|
|
281
|
+
| `safety-net.sh` | Bash से पहले | `rm -rf` और `DROP TABLE/DATABASE` ब्लॉक करता है | `.claude/settings.local.json` से हटाएं |
|
|
282
|
+
| `git-safety.sh` | Bash से पहले | फोर्स पुश, `reset --hard` ब्लॉक करता है, `git add -A` पर चेतावनी देता है | `.claude/settings.local.json` से हटाएं |
|
|
283
|
+
| `quality-gate.sh` | फ़ाइल लिखने के बाद | बदली गई फ़ाइल पर typecheck + lint चलाता है | `.claude/settings.local.json` से हटाएं |
|
|
284
|
+
| `session-init.sh` | सत्र शुरू | वर्तमान चरण/कार्य दिखाता है; 24h से अधिक दूर होने पर पूर्ण संदर्भ डंप | `.claude/settings.local.json` से हटाएं |
|
|
285
|
+
|
|
286
|
+
## कॉन्फ़िगरेशन
|
|
287
|
+
|
|
288
|
+
FRAME को `.frame/config.json` के माध्यम से कॉन्फ़िगर किया जाता है। मुख्य सेटिंग्स:
|
|
289
|
+
|
|
290
|
+
```json
|
|
291
|
+
{
|
|
292
|
+
"quality": {
|
|
293
|
+
"commands": {
|
|
294
|
+
"typecheck": "npx tsc --noEmit",
|
|
295
|
+
"test": "npx vitest run",
|
|
296
|
+
"lint": "npx eslint .",
|
|
297
|
+
"build": "npm run build"
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
## CLI
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
npx the-frame-ai init [target-dir] # FRAME इंस्टॉल करें
|
|
307
|
+
npx the-frame-ai update [target-dir] # कमांड, एजेंट, हुक्स अपडेट करें
|
|
308
|
+
npx the-frame-ai doctor [target-dir] # इंस्टॉलेशन स्वास्थ्य जांचें
|
|
309
|
+
npx the-frame-ai version # CLI संस्करण दिखाएं
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
`update` केवल कमांड, एजेंट और हुक्स अपडेट करता है। प्रोजेक्ट फ़ाइलें (STATE.md, MAP.md, memory/, आदि) कभी ओवरराइट नहीं होती हैं।
|
|
313
|
+
|
|
314
|
+
## इंस्टॉलेशन के बाद प्रोजेक्ट संरचना
|
|
315
|
+
|
|
316
|
+
```
|
|
317
|
+
.claude/
|
|
318
|
+
commands/ # 34 FRAME कमांड
|
|
319
|
+
agents/ # 5 AI एजेंट
|
|
320
|
+
hooks/ # 4 सेफ्टी हुक्स
|
|
321
|
+
.frame/
|
|
322
|
+
config.json # FRAME कॉन्फ़िगरेशन
|
|
323
|
+
.planning/
|
|
324
|
+
STATE.md # वर्तमान स्थिति
|
|
325
|
+
MAP.md # प्रोजेक्ट मैप
|
|
326
|
+
ROADMAP.md # रोडमैप
|
|
327
|
+
memory/ # प्रोजेक्ट मेमोरी
|
|
328
|
+
specs/ # सुविधा विशिष्टताएं
|
|
329
|
+
reviews/ # समीक्षा परिणाम
|
|
330
|
+
reports/ # रिपोर्ट (दैनिक, deps, गुणवत्ता, स्प्रिंट)
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
## लाइसेंस
|
|
334
|
+
|
|
335
|
+
MIT
|
package/README.ja.md
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
# THE Frame
|
|
2
|
+
|
|
3
|
+
FRAME — AI支援ソロ開発のためのフレームワーク
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇨🇳 中文](README.zh.md) | [🇮🇳 हिंदी](README.hi.md) | [🇯🇵 日本語](README.ja.md) | [🇩🇪 Deutsch](README.de.md) | [🇪🇸 Español](README.es.md) | [🇷🇺 Русский](README.ru.md)
|
|
6
|
+
|
|
7
|
+
## FRAMEとは?
|
|
8
|
+
|
|
9
|
+
**FRAME(Framework for AI-Assisted Solo Development)** は、Claude Codeでプロダクトを構築するソロ開発者のためのフレームワークです。混沌としたAI支援開発を、メモリ・構造・ミス防止機能を備えた予測可能なプロセスへと変えます — アイデアからデプロイまで。
|
|
10
|
+
|
|
11
|
+
Claude Codeで一人でプロダクトを作っていて、チームのように働きたいなら — FRAMEはあなたのためにあります。
|
|
12
|
+
|
|
13
|
+
## FRAMEが解決する問題
|
|
14
|
+
|
|
15
|
+
| 問題 | FRAMEが提供するもの |
|
|
16
|
+
|------|-------------------|
|
|
17
|
+
| セッション間でコンテキストを失う | プロジェクトメモリとセッション開始時の自動状態ダンプ |
|
|
18
|
+
| タスクと優先順位の混乱 | 6フェーズワークフロー:調査 → 計画 → 構築 → レビュー → リリース → 振り返り |
|
|
19
|
+
| 重要なものを壊す恐れ | セーフティフックが破壊的コマンドを実行前にブロック |
|
|
20
|
+
| 繰り返しのルーティンタスク | 完全な開発サイクルに対応した34の既製コマンド |
|
|
21
|
+
| 依存関係のある複雑な機能 | 独立したタスクのための並列サブエージェント |
|
|
22
|
+
| ソロ作業の構造不足 | Roadmap、STATE.md、MAP.md — 現在地と次のステップを常に把握 |
|
|
23
|
+
|
|
24
|
+
## FRAMEの使い方
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
調査 → 計画 → 構築 → レビュー → リリース → 振り返り
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
各セッションは1サイクルです。`/frame:daily` で始め、`/frame:ship` で終わります。
|
|
31
|
+
|
|
32
|
+
**調査** — 作る前に理解する
|
|
33
|
+
`/frame:research <トピック>` を実行 — Claudeがコードベースと外部ソースを探索し、次のステップのためのコンテキストを構築します。
|
|
34
|
+
|
|
35
|
+
**計画** — タスクに分解する
|
|
36
|
+
`/frame:plan <機能>` が調査を見積もり付きの具体的なタスクリストに変換します。
|
|
37
|
+
|
|
38
|
+
**構築** — 実装する
|
|
39
|
+
`/frame:build` がTDDでタスクを順次実行します(1〜3件ずつ)。多くの独立したタスクには — `/frame:wave` が並列バッチで実行します。行き詰まったら — `/frame:unstuck`。バグを発見したら — `/frame:debug`。
|
|
40
|
+
|
|
41
|
+
**レビュー** — デプロイ前に確認する
|
|
42
|
+
`/frame:review` が自動チェックを実行し、チェックリストを提供します:テスト、型、セキュリティ、パフォーマンス。
|
|
43
|
+
|
|
44
|
+
**リリース** — デプロイして記録する
|
|
45
|
+
`/frame:ship` がコミット、オプションのプッシュ/PR、プロジェクトメモリの更新を行います。
|
|
46
|
+
|
|
47
|
+
**振り返り** — 学んで改善する
|
|
48
|
+
デプロイ後に `/frame:retrospective` でメトリクスを更新し、将来のセッションのためのパターンを記録します。
|
|
49
|
+
|
|
50
|
+
## 使用例
|
|
51
|
+
|
|
52
|
+
### 新機能:Google認証を追加する
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
/frame:daily
|
|
56
|
+
# → 現在のプロジェクト状態と計画内容を確認
|
|
57
|
+
|
|
58
|
+
/frame:research "Google OAuth"
|
|
59
|
+
# → Claudeがコードベースを調査:現在のauthの仕組み、
|
|
60
|
+
# すでに使われているパターン、追加が必要なもの
|
|
61
|
+
|
|
62
|
+
/frame:plan "Google OAuth"
|
|
63
|
+
# → 具体的なタスクリストを取得:
|
|
64
|
+
# 1. Google OAuthクレデンシャルを設定
|
|
65
|
+
# 2. コールバックルートを追加
|
|
66
|
+
# 3. セッションに接続
|
|
67
|
+
# 4. UIにボタンを追加
|
|
68
|
+
|
|
69
|
+
/frame:checkpoint
|
|
70
|
+
# → 復元ポイントを保存 — 何か問題が起きたらロールバック可能
|
|
71
|
+
|
|
72
|
+
/frame:wave
|
|
73
|
+
# → タスク1〜4は独立しているため、Claudeが並列で実行
|
|
74
|
+
|
|
75
|
+
/frame:review
|
|
76
|
+
# → 自動チェック:テスト、型、セキュリティ
|
|
77
|
+
|
|
78
|
+
/frame:ship
|
|
79
|
+
# → コミット、オプションのプッシュ/PR、プロジェクトメモリ更新
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### バグ:パスワードリセット後にユーザーがログインできない
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
/frame:daily
|
|
86
|
+
# → コンテキストを復元し、バグが既に計画にあるか確認または追加
|
|
87
|
+
|
|
88
|
+
/frame:debug "login after reset"
|
|
89
|
+
# → Claudeが体系的に確認:ログ、リセットフロー、セッション、トークン
|
|
90
|
+
# → コード内の具体的な場所を示す仮説を取得
|
|
91
|
+
|
|
92
|
+
# 原因がすぐに判明した場合:
|
|
93
|
+
/frame:checkpoint # 修正前の復元ポイント
|
|
94
|
+
/frame:fast "fix: invalidate old session after password reset"
|
|
95
|
+
# → Claudeがピンポイントの修正を行い、リグレッションテストを書く
|
|
96
|
+
|
|
97
|
+
# 原因が不明な場合 — 深く掘り下げる:
|
|
98
|
+
/frame:forensics
|
|
99
|
+
# → この領域の変更のgit履歴を分析し、
|
|
100
|
+
# 動作を壊したコミットを特定
|
|
101
|
+
|
|
102
|
+
/frame:checkpoint
|
|
103
|
+
/frame:fast "fix: ..." # 特定した原因を修正
|
|
104
|
+
|
|
105
|
+
/frame:review
|
|
106
|
+
# → 修正が他のログインシナリオを壊していないことを確認
|
|
107
|
+
|
|
108
|
+
/frame:ship
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 改善:ダッシュボードの読み込みを高速化する
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
/frame:daily
|
|
115
|
+
|
|
116
|
+
/frame:performance
|
|
117
|
+
# → ベースラインを取得:バンドルサイズ、読み込み時間、Lighthouseスコア
|
|
118
|
+
# 数値を記録 — 最後の比較に必要
|
|
119
|
+
|
|
120
|
+
/frame:research "dashboard performance"
|
|
121
|
+
# → Claudeがダッシュボードコードを分析:重いコンポーネント、
|
|
122
|
+
# 冗長なリクエスト、キャッシュまたは遅延読み込みできるもの
|
|
123
|
+
|
|
124
|
+
/frame:plan "dashboard optimization"
|
|
125
|
+
# → 影響見積もり付きのタスクリスト:
|
|
126
|
+
# 1. 重いチャートを遅延読み込み
|
|
127
|
+
# 2. APIリクエストをキャッシュ
|
|
128
|
+
# 3. マウント時の重複リクエストを削除
|
|
129
|
+
|
|
130
|
+
/frame:build
|
|
131
|
+
# → 順次実行、各タスクにテスト付き
|
|
132
|
+
|
|
133
|
+
/frame:performance
|
|
134
|
+
# → ベースラインと比較:実際の改善を確認
|
|
135
|
+
|
|
136
|
+
/frame:ship
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## 内容
|
|
140
|
+
|
|
141
|
+
FRAMEが提供するもの:
|
|
142
|
+
|
|
143
|
+
- **6フェーズワークフロー**:調査 → 計画 → 構築 → レビュー → リリース → 振り返り
|
|
144
|
+
- **34コマンド**:クイックタスクから完全な機能開発サイクルまで
|
|
145
|
+
- **5つのAIエージェント**:リサーチャー、プランナー、ビルダー、レビュアー、悪魔の代弁者
|
|
146
|
+
- **セーフティフック**:破壊的操作をブロック、品質ゲートを強制
|
|
147
|
+
- **Git安全機能**:チェックポイント、ロールバック、ワークツリー、一時停止/再開
|
|
148
|
+
|
|
149
|
+
## 前提条件
|
|
150
|
+
|
|
151
|
+
- Node.js >= 18
|
|
152
|
+
- Git(プロジェクトはgitリポジトリである必要があります)
|
|
153
|
+
|
|
154
|
+
## クイックスタート
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
# 必要に応じてgitリポジトリを初期化
|
|
158
|
+
git init && git commit --allow-empty -m "init"
|
|
159
|
+
|
|
160
|
+
# FRAMEをインストール
|
|
161
|
+
npx the-frame-ai init
|
|
162
|
+
|
|
163
|
+
# このプロジェクトでClaude Codeを開いて実行:
|
|
164
|
+
/frame:init # コードベースをスキャンし、MAP.mdを埋める
|
|
165
|
+
/frame:daily # 毎日のエントリーポイント
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## コマンド
|
|
169
|
+
|
|
170
|
+
### コア — ここから始める
|
|
171
|
+
|
|
172
|
+
この7つのコマンドがソロ開発作業の90%をカバーします:
|
|
173
|
+
|
|
174
|
+
| コマンド | 使用タイミング |
|
|
175
|
+
|---------|-------------|
|
|
176
|
+
| `/frame:daily` | 休憩後は**ここから始める** — 何が完了し、次は何か |
|
|
177
|
+
| `/frame:research <トピック>` | 新機能の計画前 |
|
|
178
|
+
| `/frame:plan <機能>` | 調査を実行可能なタスクリストに変換 |
|
|
179
|
+
| `/frame:build` | TDDで1〜3タスクを実装(順次) |
|
|
180
|
+
| `/frame:wave` | 4つ以上の独立したタスクを実装(並列サブエージェント) |
|
|
181
|
+
| `/frame:review` | デプロイ前 — 自動チェック + チェックリスト |
|
|
182
|
+
| `/frame:ship` | コミット、オプションのプッシュ/PR、メモリ更新 |
|
|
183
|
+
|
|
184
|
+
### フェーズ別全コマンド
|
|
185
|
+
|
|
186
|
+
<details>
|
|
187
|
+
<summary>調査</summary>
|
|
188
|
+
|
|
189
|
+
| コマンド | 使用タイミング |
|
|
190
|
+
|---------|-------------|
|
|
191
|
+
| `/frame:research <トピック>` | 新機能の計画前 |
|
|
192
|
+
| `/frame:explain <ファイル>` | このコードがこうなっている理由は? |
|
|
193
|
+
| `/frame:why <トピック>` | 意思決定の履歴を検索 |
|
|
194
|
+
</details>
|
|
195
|
+
|
|
196
|
+
<details>
|
|
197
|
+
<summary>計画</summary>
|
|
198
|
+
|
|
199
|
+
| コマンド | 使用タイミング |
|
|
200
|
+
|---------|-------------|
|
|
201
|
+
| `/frame:plan <機能>` | 調査を実行可能なタスクリストに変換 |
|
|
202
|
+
| `/frame:add-task` | 作業を中断せずに計画にタスクを追加 |
|
|
203
|
+
</details>
|
|
204
|
+
|
|
205
|
+
<details>
|
|
206
|
+
<summary>構築</summary>
|
|
207
|
+
|
|
208
|
+
| コマンド | 使用タイミング |
|
|
209
|
+
|---------|-------------|
|
|
210
|
+
| `/frame:build` | TDDで計画を実装(1〜3タスク、順次) |
|
|
211
|
+
| `/frame:wave` | 4つ以上の独立したタスクを並列バッチで実装 |
|
|
212
|
+
| `/frame:fast <タスク>` | 30分以内のクイックタスク |
|
|
213
|
+
| `/frame:debug <問題>` | 体系的なバグ調査 |
|
|
214
|
+
| `/frame:forensics` | 何かが壊れた原因の深掘り |
|
|
215
|
+
| `/frame:refactor` | TDDセーフティネットでリファクタリング |
|
|
216
|
+
| `/frame:migrate` | ロールバック計画付きのDB/API/deps移行 |
|
|
217
|
+
</details>
|
|
218
|
+
|
|
219
|
+
<details>
|
|
220
|
+
<summary>レビュー</summary>
|
|
221
|
+
|
|
222
|
+
| コマンド | 使用タイミング |
|
|
223
|
+
|---------|-------------|
|
|
224
|
+
| `/frame:review` | デプロイ前 — 自動チェック + チェックリスト |
|
|
225
|
+
| `/frame:health` | プロジェクト全体のヘルスチェック |
|
|
226
|
+
| `/frame:check-deps` | セキュリティ監査 + 古いパッケージ |
|
|
227
|
+
| `/frame:performance` | バンドルサイズとLighthouse監査 |
|
|
228
|
+
</details>
|
|
229
|
+
|
|
230
|
+
<details>
|
|
231
|
+
<summary>リリース</summary>
|
|
232
|
+
|
|
233
|
+
| コマンド | 使用タイミング |
|
|
234
|
+
|---------|-------------|
|
|
235
|
+
| `/frame:ship` | コミット、オプションのプッシュ/PR、メモリ更新 |
|
|
236
|
+
| `/frame:checkpoint` | リスクのある変更前にgitタグを保存 |
|
|
237
|
+
| `/frame:rollback` | チェックポイントにロールバック |
|
|
238
|
+
</details>
|
|
239
|
+
|
|
240
|
+
<details>
|
|
241
|
+
<summary>振り返り</summary>
|
|
242
|
+
|
|
243
|
+
| コマンド | 使用タイミング |
|
|
244
|
+
|---------|-------------|
|
|
245
|
+
| `/frame:retrospective` | デプロイ後 — メモリとメトリクスを更新 |
|
|
246
|
+
| `/frame:sprint-check` | ロードマップに対する週次進捗 |
|
|
247
|
+
| `/frame:cleanup-memory` | 古いメモリのトリムとアーカイブ |
|
|
248
|
+
</details>
|
|
249
|
+
|
|
250
|
+
<details>
|
|
251
|
+
<summary>日常 & ユーティリティ</summary>
|
|
252
|
+
|
|
253
|
+
| コマンド | 使用タイミング |
|
|
254
|
+
|---------|-------------|
|
|
255
|
+
| `/frame:daily` | 1日の始まり — 何が完了し、次は何か |
|
|
256
|
+
| `/frame:status` | 完全な状態ダンプ(git、メモリ、ブロッカー) |
|
|
257
|
+
| `/frame:note` | パターン、決定、またはアンチパターンを記録 |
|
|
258
|
+
| `/frame:unstuck` | 行き詰まった?ブロックを解除する3つの具体的な選択肢を取得 |
|
|
259
|
+
| `/frame:context` | 現在の作業コンテキストを表示 |
|
|
260
|
+
| `/frame:init` | 初回実行 — コードベースをスキャン、MAP.mdを埋める |
|
|
261
|
+
| `/frame:doctor` | FRAMEのインストールを確認 |
|
|
262
|
+
| `/frame:pause` / `/frame:resume` | タスク途中の状態を保存・復元 |
|
|
263
|
+
</details>
|
|
264
|
+
|
|
265
|
+
<details>
|
|
266
|
+
<summary>上級</summary>
|
|
267
|
+
|
|
268
|
+
| コマンド | 使用タイミング |
|
|
269
|
+
|---------|-------------|
|
|
270
|
+
| `/frame:worktree` | 並列実験のための隔離されたgitワークツリー |
|
|
271
|
+
| `/frame:headless` | 自律CIモード(インタラクションなし) |
|
|
272
|
+
| `/frame:estimate <タスク>` | 開始前のスコープと時間見積もり |
|
|
273
|
+
</details>
|
|
274
|
+
|
|
275
|
+
## フック
|
|
276
|
+
|
|
277
|
+
FRAMEは `.claude/hooks/` に4つのフックをインストールします。自動的に実行されます。
|
|
278
|
+
|
|
279
|
+
| フック | トリガー | 機能 | 無効化方法 |
|
|
280
|
+
|-------|---------|------|----------|
|
|
281
|
+
| `safety-net.sh` | Bash実行前 | `rm -rf` と `DROP TABLE/DATABASE` をブロック | `.claude/settings.local.json` から削除 |
|
|
282
|
+
| `git-safety.sh` | Bash実行前 | フォースプッシュ、`reset --hard` をブロック、`git add -A` に警告 | `.claude/settings.local.json` から削除 |
|
|
283
|
+
| `quality-gate.sh` | ファイル書き込み後 | 変更されたファイルにtypecheck + lintを実行 | `.claude/settings.local.json` から削除 |
|
|
284
|
+
| `session-init.sh` | セッション開始 | 現在のフェーズ/タスクを表示;24時間以上離れていた場合は完全なコンテキストダンプ | `.claude/settings.local.json` から削除 |
|
|
285
|
+
|
|
286
|
+
## 設定
|
|
287
|
+
|
|
288
|
+
FRAMEは `.frame/config.json` で設定します。主要な設定:
|
|
289
|
+
|
|
290
|
+
```json
|
|
291
|
+
{
|
|
292
|
+
"quality": {
|
|
293
|
+
"commands": {
|
|
294
|
+
"typecheck": "npx tsc --noEmit",
|
|
295
|
+
"test": "npx vitest run",
|
|
296
|
+
"lint": "npx eslint .",
|
|
297
|
+
"build": "npm run build"
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
## CLI
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
npx the-frame-ai init [target-dir] # FRAMEをインストール
|
|
307
|
+
npx the-frame-ai update [target-dir] # コマンド、エージェント、フックを更新
|
|
308
|
+
npx the-frame-ai doctor [target-dir] # インストールの健全性を確認
|
|
309
|
+
npx the-frame-ai version # CLIバージョンを表示
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
`update` はコマンド、エージェント、フックのみを更新します。プロジェクトファイル(STATE.md、MAP.md、memory/ など)は上書きされません。
|
|
313
|
+
|
|
314
|
+
## インストール後のプロジェクト構造
|
|
315
|
+
|
|
316
|
+
```
|
|
317
|
+
.claude/
|
|
318
|
+
commands/ # 34のFRAMEコマンド
|
|
319
|
+
agents/ # 5つのAIエージェント
|
|
320
|
+
hooks/ # 4つのセーフティフック
|
|
321
|
+
.frame/
|
|
322
|
+
config.json # FRAME設定
|
|
323
|
+
.planning/
|
|
324
|
+
STATE.md # 現在の位置
|
|
325
|
+
MAP.md # プロジェクトマップ
|
|
326
|
+
ROADMAP.md # ロードマップ
|
|
327
|
+
memory/ # プロジェクトメモリ
|
|
328
|
+
specs/ # 機能仕様
|
|
329
|
+
reviews/ # レビュー結果
|
|
330
|
+
reports/ # レポート(日次、deps、品質、スプリント)
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
## ライセンス
|
|
334
|
+
|
|
335
|
+
MIT
|