create-agentic-starter 0.1.7 → 0.1.8
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.md +5 -1
- package/dist/index.js +356 -156
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,7 +28,9 @@ Run the command inside an existing project folder.
|
|
|
28
28
|
The scaffold is non-interactive. It will:
|
|
29
29
|
|
|
30
30
|
- recreate `.agentic/`
|
|
31
|
-
-
|
|
31
|
+
- create `.docs/` for user-facing outputs
|
|
32
|
+
- preserve existing `AGENTS.md`, appending a marked `create-agentic-starter` section when needed
|
|
33
|
+
- never modify `.gitignore`
|
|
32
34
|
- never modify `README.md`
|
|
33
35
|
- print the next step for the team
|
|
34
36
|
|
|
@@ -42,6 +44,8 @@ The command sets up:
|
|
|
42
44
|
- `.agentic/workspace/project/`
|
|
43
45
|
- `.agentic/workspace/memory/`
|
|
44
46
|
- `.agentic/workspace/documents/`
|
|
47
|
+
- `.agentic/workspace/scripts/`
|
|
48
|
+
- `.docs/`
|
|
45
49
|
- `AGENTS.md`
|
|
46
50
|
|
|
47
51
|
## First Run Flow
|
package/dist/index.js
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{mkdir as
|
|
3
|
-
`);let
|
|
2
|
+
import{mkdir as R,rm as A,writeFile as q}from"fs/promises";import p from"path";import{readFile as v,writeFile as m}from"fs/promises";import j from"path";function u(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}function I(e,t,s,r){let n=new RegExp(`${u(s)}[\\s\\S]*?${u(r)}\\n?`,"m");if(n.test(e))return e.replace(n,`${t}
|
|
3
|
+
`);let o=e.endsWith(`
|
|
4
4
|
`)?`
|
|
5
5
|
`:`
|
|
6
6
|
|
|
7
|
-
`;return`${e}${
|
|
8
|
-
`}async function
|
|
9
|
-
`,"utf8")}}var f="AGENTS.md",
|
|
7
|
+
`;return`${e}${o}${t}
|
|
8
|
+
`}async function h(e,t,s,r,n){let o=j.join(e,t);try{let a=await v(o,"utf8"),b=I(a,s,r,n);await m(o,b,"utf8")}catch(a){if(a.code!=="ENOENT")throw a;await m(o,`${s}
|
|
9
|
+
`,"utf8")}}var f="AGENTS.md",i="<!-- from create-agentic-starter:agents:start -->",c="<!-- from create-agentic-starter:agents:end -->",g=`${i}
|
|
10
10
|
# Agentic Starter Guide
|
|
11
11
|
|
|
12
|
-
This project includes a reusable AI working area under \`.agentic/\` for project kick-off and
|
|
12
|
+
This project includes a reusable AI working area under \`.agentic/\` for project kick-off and delivery documentation.
|
|
13
13
|
|
|
14
14
|
## What This Is For
|
|
15
15
|
|
|
@@ -17,146 +17,70 @@ Use this scaffold when you want an AI tool to:
|
|
|
17
17
|
|
|
18
18
|
- understand a project from files, notes, screenshots, and links
|
|
19
19
|
- maintain structured project memory
|
|
20
|
-
-
|
|
20
|
+
- prepare internal drafts in \`.agentic/workspace/\`
|
|
21
|
+
- create user-facing deliverables in \`.docs/\`
|
|
22
|
+
- optionally use Node.js export helpers from \`.agentic/workspace/scripts/\`
|
|
21
23
|
|
|
22
24
|
## Folder Purpose
|
|
23
25
|
|
|
24
26
|
- \`.agentic/init.md\`: first prompt for every new AI session
|
|
25
27
|
- \`.agentic/context.md\`: shared rules and folder map
|
|
26
28
|
- \`.agentic/commands/\`: task-specific prompt files you reference in your AI tool
|
|
27
|
-
- \`.agentic/workspace/project/\`: raw project inputs such as screenshots, notes, requirement docs, and
|
|
29
|
+
- \`.agentic/workspace/project/\`: raw project inputs such as screenshots, notes, requirement docs, and references
|
|
28
30
|
- \`.agentic/workspace/memory/\`: evolving AI-maintained project understanding
|
|
29
|
-
- \`.agentic/workspace/documents/\`:
|
|
31
|
+
- \`.agentic/workspace/documents/\`: internal drafts and intermediate artifacts
|
|
32
|
+
- \`.agentic/workspace/scripts/\`: optional Node export helpers
|
|
33
|
+
- \`.docs/\`: user-facing deliverables
|
|
30
34
|
|
|
31
35
|
## How To Use It
|
|
32
36
|
|
|
33
37
|
1. Open your AI tool in this project.
|
|
34
38
|
2. Start every new session with \`@.agentic/init.md\`.
|
|
35
|
-
3. Follow the command
|
|
39
|
+
3. Follow the command flow below.
|
|
36
40
|
|
|
37
|
-
##
|
|
41
|
+
## Command Flow
|
|
38
42
|
|
|
39
43
|
1. \`@.agentic/init.md\`
|
|
40
44
|
2. \`@.agentic/commands/project-requirements.md\`
|
|
41
45
|
3. \`@.agentic/commands/architecture.md\`
|
|
42
|
-
4.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
+
4. Then choose from the available options shown by the current command, such as:
|
|
47
|
+
- \`@.agentic/commands/create-brd.md\`
|
|
48
|
+
- \`@.agentic/commands/create-frd.md\`
|
|
49
|
+
- \`@.agentic/commands/create-estimate.md\`
|
|
50
|
+
- \`@.agentic/commands/create-proposal.md\`
|
|
51
|
+
- \`@.agentic/commands/create-plan.md\`
|
|
52
|
+
- \`@.agentic/commands/create-tasks.md\`
|
|
46
53
|
|
|
47
|
-
|
|
48
|
-
${m}
|
|
49
|
-
`,k=`${d}
|
|
50
|
-
.agentic/workspace/documents/
|
|
51
|
-
.agentic/workspace/memory/
|
|
52
|
-
${p}
|
|
53
|
-
`;var y=[".agentic"],x=[".agentic",".agentic/commands",".agentic/workspace",".agentic/workspace/project",".agentic/workspace/memory",".agentic/workspace/documents"],v=()=>({".agentic/init.md":`# Init
|
|
54
|
+
## Output Conventions
|
|
54
55
|
|
|
55
|
-
|
|
56
|
+
Default user-facing outputs live under \`.docs/\`:
|
|
56
57
|
|
|
57
|
-
|
|
58
|
+
- BRD: \`.docs/brd/brd.docx\`
|
|
59
|
+
- FRD: \`.docs/frd/frd.docx\`
|
|
60
|
+
- Estimate: \`.docs/estimate/estimate.xlsx\`
|
|
61
|
+
- Proposal: \`.docs/proposal/proposal.pptx\`
|
|
62
|
+
- Plan: \`.docs/plan/plan.docx\` or \`.docs/plan/plan.xlsx\`
|
|
63
|
+
- Tasks: \`.docs/tasks/tasks.xlsx\`
|
|
58
64
|
|
|
59
|
-
##
|
|
60
|
-
|
|
61
|
-
1. Read only root-level files and folders in the current project.
|
|
62
|
-
2. Do not recursively inspect the full repository.
|
|
63
|
-
3. Treat \`.agentic/\` as the exception:
|
|
64
|
-
- inspect \`.agentic/workspace/project/\`
|
|
65
|
-
- inspect \`.agentic/workspace/memory/\`
|
|
66
|
-
- inspect \`.agentic/workspace/documents/\`
|
|
67
|
-
4. Use existing workspace context if it is already present.
|
|
65
|
+
## Export Helpers
|
|
68
66
|
|
|
69
|
-
|
|
67
|
+
Optional export scripts can live under \`.agentic/workspace/scripts/\`.
|
|
70
68
|
|
|
71
|
-
|
|
72
|
-
2. Do not dump a full file inventory unless the user explicitly asks.
|
|
73
|
-
3. Do not mirror the prompt structure back to the user.
|
|
74
|
-
4. Respond with either:
|
|
75
|
-
- a short synthesized summary of what you understand, or
|
|
76
|
-
- a few focused questions if important context is still missing
|
|
77
|
-
|
|
78
|
-
## What To Do
|
|
79
|
-
|
|
80
|
-
1. Infer what kind of project this is from the root-level signals.
|
|
81
|
-
2. Check whether \`.agentic/workspace/project/\`, \`.agentic/workspace/memory/\`, and \`.agentic/workspace/documents/\` already contain useful context.
|
|
82
|
-
3. Build the best current understanding from:
|
|
83
|
-
- root-level signals
|
|
84
|
-
- existing workspace files
|
|
85
|
-
- the user's message in this chat
|
|
86
|
-
4. If project context is thin, ask a small number of targeted questions about:
|
|
87
|
-
- project goal
|
|
88
|
-
- target users
|
|
89
|
-
- scope or modules
|
|
90
|
-
- available references such as screenshots, docs, notes, links, or file paths
|
|
91
|
-
- desired outputs
|
|
92
|
-
5. If enough context exists, give a short summary of the project and the most important missing pieces.
|
|
93
|
-
6. If the user mentions screenshots, notes, requirement docs, links, or file paths, move or organize them into \`.agentic/workspace/project/\` by default unless the user explicitly says not to.
|
|
94
|
-
7. After the first useful exchange, create or update:
|
|
95
|
-
- \`.agentic/workspace/memory/project-overview.md\`
|
|
96
|
-
- \`.agentic/workspace/memory/requirements.md\`
|
|
97
|
-
- \`.agentic/workspace/memory/open-questions.md\`
|
|
98
|
-
8. Write drafts even from partial information.
|
|
99
|
-
9. Clearly separate confirmed facts, assumptions, and open questions.
|
|
100
|
-
10. Do not route immediately just because the workspace is empty. Do useful synthesis or ask focused questions first.
|
|
101
|
-
11. If important project basics are still missing, continue asking focused questions and keep updating the memory files instead of routing forward yet.
|
|
102
|
-
12. Only when you have done enough useful intake work to create a solid initial understanding, end with:
|
|
69
|
+
Dependency guidance:
|
|
103
70
|
|
|
104
|
-
|
|
105
|
-
|
|
71
|
+
1. Prefer the target project root if it already has a usable Node environment.
|
|
72
|
+
2. If root is not suitable, ask the user which path should receive the install.
|
|
73
|
+
3. Ask the user before running any \`npm install\`.
|
|
106
74
|
|
|
107
|
-
|
|
75
|
+
Planned library stack:
|
|
108
76
|
|
|
109
|
-
|
|
77
|
+
- \`docx\`
|
|
78
|
+
- \`pptxgenjs\`
|
|
79
|
+
- \`exceljs\`
|
|
110
80
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
- \`.agentic/workspace/project/\`: raw project materials
|
|
115
|
-
- \`.agentic/workspace/memory/\`: evolving AI-maintained understanding
|
|
116
|
-
- \`.agentic/workspace/documents/\`: polished markdown outputs
|
|
117
|
-
|
|
118
|
-
## Workspace Semantics
|
|
119
|
-
|
|
120
|
-
### Project
|
|
121
|
-
|
|
122
|
-
Use \`.agentic/workspace/project/\` for:
|
|
123
|
-
|
|
124
|
-
- Figma screenshots
|
|
125
|
-
- requirement notes
|
|
126
|
-
- requirement documents
|
|
127
|
-
- links captured into markdown files
|
|
128
|
-
- user-supplied project references
|
|
129
|
-
|
|
130
|
-
If relevant project materials are found outside this folder, move or organize them into \`.agentic/workspace/project/\` by default. Only leave them in place if the user explicitly says not to move them.
|
|
131
|
-
|
|
132
|
-
### Memory
|
|
133
|
-
|
|
134
|
-
Use \`.agentic/workspace/memory/\` for:
|
|
135
|
-
|
|
136
|
-
- \`project-overview.md\`
|
|
137
|
-
- \`requirements.md\`
|
|
138
|
-
- \`open-questions.md\`
|
|
139
|
-
- \`architecture.md\`
|
|
140
|
-
- assumptions and structured working memory
|
|
141
|
-
|
|
142
|
-
### Documents
|
|
143
|
-
|
|
144
|
-
Use \`.agentic/workspace/documents/\` for polished outputs:
|
|
145
|
-
|
|
146
|
-
- \`brd.md\`
|
|
147
|
-
- \`frd.md\`
|
|
148
|
-
- \`estimate.md\`
|
|
149
|
-
- \`proposal.md\`
|
|
150
|
-
|
|
151
|
-
## Working Rules
|
|
152
|
-
|
|
153
|
-
1. Reuse and improve existing workspace files when they already exist.
|
|
154
|
-
2. Do not scan the whole repository unless the user explicitly asks.
|
|
155
|
-
3. If relevant project assets are outside \`.agentic/workspace/project/\`, move them into the workspace by default and then use the workspace copy.
|
|
156
|
-
4. Only avoid moving files when the user explicitly asks to keep them in place.
|
|
157
|
-
5. Ask only the minimum blocking questions required to continue.
|
|
158
|
-
6. Always end by telling the user the exact next command to run.
|
|
159
|
-
`,".agentic/commands/project-requirements.md":`# Project Requirements
|
|
81
|
+
If your tool does not support \`@file\` references, paste the contents of the prompt file into a new chat manually.
|
|
82
|
+
${c}
|
|
83
|
+
`;var k={".agentic/commands/project-requirements.md":`# Project Requirements
|
|
160
84
|
|
|
161
85
|
Read:
|
|
162
86
|
|
|
@@ -174,19 +98,21 @@ Read:
|
|
|
174
98
|
- existing file paths already shared by the user, or
|
|
175
99
|
- fresh explanation typed in chat
|
|
176
100
|
4. Move or organize project inputs into \`.agentic/workspace/project/\` by default unless the user explicitly says not to.
|
|
177
|
-
5. Organize and normalize the project context so
|
|
101
|
+
5. Organize and normalize the project context so later architecture and deliverable steps can rely on it.
|
|
178
102
|
6. Create or update:
|
|
179
103
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
180
104
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
181
105
|
- \`.agentic/workspace/memory/open-questions.md\`
|
|
182
106
|
7. Capture assumptions separately from confirmed facts.
|
|
183
|
-
8. Reduce open questions where possible before handing off
|
|
107
|
+
8. Reduce open questions where possible before handing off.
|
|
184
108
|
9. If the requirement understanding is still weak or important gaps remain, continue asking focused project questions and keep updating the memory files.
|
|
185
109
|
10. Only ask for missing details that block useful requirement understanding.
|
|
186
110
|
|
|
187
|
-
When the requirements are strong enough
|
|
111
|
+
When the requirements are strong enough, tell the user the available next options:
|
|
188
112
|
|
|
189
|
-
|
|
113
|
+
- \`@.agentic/commands/architecture.md\` (recommended)
|
|
114
|
+
- \`@.agentic/commands/create-plan.md\`
|
|
115
|
+
- \`@.agentic/commands/create-proposal.md\`
|
|
190
116
|
`,".agentic/commands/architecture.md":`# Architecture
|
|
191
117
|
|
|
192
118
|
Read:
|
|
@@ -208,9 +134,12 @@ Read:
|
|
|
208
134
|
7. If architecture-critical information is still missing, ask architecture-specific questions and keep updating \`.agentic/workspace/memory/architecture.md\` instead of routing yet.
|
|
209
135
|
8. Ask only the minimum blocking questions.
|
|
210
136
|
|
|
211
|
-
When the architecture is strong enough
|
|
137
|
+
When the architecture is strong enough, tell the user the available next options:
|
|
212
138
|
|
|
213
|
-
|
|
139
|
+
- \`@.agentic/commands/create-brd.md\`
|
|
140
|
+
- \`@.agentic/commands/create-proposal.md\`
|
|
141
|
+
- \`@.agentic/commands/create-plan.md\`
|
|
142
|
+
- \`@.agentic/commands/create-tasks.md\`
|
|
214
143
|
`,".agentic/commands/create-brd.md":`# Create BRD
|
|
215
144
|
|
|
216
145
|
Read:
|
|
@@ -223,11 +152,18 @@ Read:
|
|
|
223
152
|
|
|
224
153
|
## Your job
|
|
225
154
|
|
|
226
|
-
1.
|
|
227
|
-
2. Produce
|
|
228
|
-
3.
|
|
229
|
-
4. If
|
|
230
|
-
5.
|
|
155
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/brd.*\` if useful.
|
|
156
|
+
2. Produce the user-facing BRD at \`.docs/brd/brd.docx\`.
|
|
157
|
+
3. Assume Node.js export scripts will later convert structured content and templates into the final \`.docx\`.
|
|
158
|
+
4. If the user already provided a template file/path/reference, follow it.
|
|
159
|
+
5. Otherwise ask whether they want a specific BRD style or structure.
|
|
160
|
+
6. If neither a template nor a style is provided, use the built-in default structure.
|
|
161
|
+
7. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
162
|
+
8. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
163
|
+
9. Ask the user before running any \`npm install\`.
|
|
164
|
+
10. Use confirmed facts first and clearly label assumptions where needed.
|
|
165
|
+
11. If relevant source material is outside \`.agentic/workspace/project/\`, move or organize it into the workspace by default unless the user explicitly says not to.
|
|
166
|
+
12. If critical information is missing, ask only the minimum blocking questions and keep improving the BRD draft instead of routing yet.
|
|
231
167
|
|
|
232
168
|
When the BRD is solid enough to define functional requirements, tell the user:
|
|
233
169
|
|
|
@@ -240,17 +176,22 @@ Read:
|
|
|
240
176
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
241
177
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
242
178
|
- \`.agentic/workspace/memory/architecture.md\`
|
|
243
|
-
- \`.agentic/workspace/documents/brd
|
|
179
|
+
- \`.agentic/workspace/documents/brd.*\` if it exists
|
|
244
180
|
- relevant files under \`.agentic/workspace/project/\`
|
|
245
181
|
|
|
246
182
|
## Your job
|
|
247
183
|
|
|
248
|
-
1.
|
|
249
|
-
2. Produce
|
|
250
|
-
3.
|
|
251
|
-
4.
|
|
252
|
-
5. If
|
|
253
|
-
6.
|
|
184
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/frd.*\` if useful.
|
|
185
|
+
2. Produce the user-facing FRD at \`.docs/frd/frd.docx\`.
|
|
186
|
+
3. Assume Node.js export scripts will later convert structured content into the final \`.docx\`.
|
|
187
|
+
4. Keep the content behavior straightforward unless the user explicitly supplies a template or style preference.
|
|
188
|
+
5. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
189
|
+
6. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
190
|
+
7. Ask the user before running any \`npm install\`.
|
|
191
|
+
8. Cover modules, flows, validations, roles, and edge cases where relevant.
|
|
192
|
+
9. If relevant source material is outside \`.agentic/workspace/project/\`, move or organize it into the workspace by default unless the user explicitly says not to.
|
|
193
|
+
10. If important functional details are still missing, ask focused follow-up questions and keep improving the FRD instead of routing yet.
|
|
194
|
+
11. Ask only the minimum blocking questions.
|
|
254
195
|
|
|
255
196
|
When the FRD is strong enough for estimation, tell the user:
|
|
256
197
|
|
|
@@ -263,17 +204,24 @@ Read:
|
|
|
263
204
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
264
205
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
265
206
|
- \`.agentic/workspace/memory/architecture.md\`
|
|
266
|
-
- \`.agentic/workspace/documents/brd
|
|
267
|
-
- \`.agentic/workspace/documents/frd
|
|
207
|
+
- \`.agentic/workspace/documents/brd.*\` if it exists
|
|
208
|
+
- \`.agentic/workspace/documents/frd.*\` if it exists
|
|
268
209
|
|
|
269
210
|
## Your job
|
|
270
211
|
|
|
271
|
-
1.
|
|
272
|
-
2. Produce
|
|
273
|
-
3.
|
|
274
|
-
4. If
|
|
275
|
-
5.
|
|
276
|
-
6.
|
|
212
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/estimate.*\` if useful.
|
|
213
|
+
2. Produce the user-facing estimate at \`.docs/estimate/estimate.xlsx\`.
|
|
214
|
+
3. Assume Node.js export scripts will later convert structured content and templates into the final \`.xlsx\`.
|
|
215
|
+
4. If the user already provided a template file/path/reference, follow it.
|
|
216
|
+
5. Otherwise ask whether they want a specific estimate style or structure.
|
|
217
|
+
6. If neither a template nor a style is provided, use the built-in default structure.
|
|
218
|
+
7. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
219
|
+
8. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
220
|
+
9. Ask the user before running any \`npm install\`.
|
|
221
|
+
10. Keep the estimate aligned with the known scope and clearly state uncertainty.
|
|
222
|
+
11. If relevant source material is outside \`.agentic/workspace/project/\`, move or organize it into the workspace by default unless the user explicitly says not to.
|
|
223
|
+
12. If the estimate is too uncertain because key delivery information is missing, ask focused follow-up questions and keep refining the estimate instead of routing yet.
|
|
224
|
+
13. Ask only the minimum blocking questions.
|
|
277
225
|
|
|
278
226
|
When the estimate is strong enough for proposal drafting, tell the user:
|
|
279
227
|
|
|
@@ -286,18 +234,270 @@ Read:
|
|
|
286
234
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
287
235
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
288
236
|
- \`.agentic/workspace/memory/architecture.md\`
|
|
289
|
-
- \`.agentic/workspace/documents/brd
|
|
290
|
-
- \`.agentic/workspace/documents/frd
|
|
291
|
-
- \`.agentic/workspace/documents/estimate
|
|
237
|
+
- \`.agentic/workspace/documents/brd.*\` if it exists
|
|
238
|
+
- \`.agentic/workspace/documents/frd.*\` if it exists
|
|
239
|
+
- \`.agentic/workspace/documents/estimate.*\` if it exists
|
|
240
|
+
|
|
241
|
+
## Your job
|
|
242
|
+
|
|
243
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/proposal.*\` if useful.
|
|
244
|
+
2. Produce the user-facing proposal at \`.docs/proposal/proposal.pptx\`.
|
|
245
|
+
3. Assume Node.js export scripts will later convert structured content and templates into the final \`.pptx\`.
|
|
246
|
+
4. Keep the prompt focused on presentation-ready content unless the user explicitly provides a template or style preference.
|
|
247
|
+
5. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
248
|
+
6. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
249
|
+
7. Ask the user before running any \`npm install\`.
|
|
250
|
+
8. Make gaps explicit instead of inventing details.
|
|
251
|
+
9. If relevant screenshots, decks, notes, or references are found outside \`.agentic/workspace/project/\`, move or organize them into the workspace by default unless the user explicitly says not to.
|
|
252
|
+
10. If key proposal inputs are still missing, ask focused questions and keep improving the proposal instead of prematurely declaring completion.
|
|
253
|
+
11. Ask only the minimum blocking questions.
|
|
254
|
+
|
|
255
|
+
When the proposal is complete enough for handoff, tell the user the workflow is complete and list the generated files.
|
|
256
|
+
`,".agentic/commands/create-plan.md":`# Create Plan
|
|
257
|
+
|
|
258
|
+
Read:
|
|
259
|
+
|
|
260
|
+
- \`@.agentic/context.md\`
|
|
261
|
+
- \`.agentic/workspace/memory/project-overview.md\`
|
|
262
|
+
- \`.agentic/workspace/memory/requirements.md\`
|
|
263
|
+
- \`.agentic/workspace/memory/architecture.md\` if it exists
|
|
264
|
+
- relevant files under \`.agentic/workspace/project/\`
|
|
292
265
|
|
|
293
266
|
## Your job
|
|
294
267
|
|
|
295
|
-
1.
|
|
296
|
-
2.
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
268
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/plan.*\` if useful.
|
|
269
|
+
2. If the user has not already specified the preferred plan output, ask whether they want:
|
|
270
|
+
- a document-style plan, or
|
|
271
|
+
- a spreadsheet-style plan
|
|
272
|
+
3. If the user already provided a template file/path/reference, follow it.
|
|
273
|
+
4. Otherwise ask whether they want a specific plan style or structure.
|
|
274
|
+
5. If neither a template nor a style is provided, use the built-in default structure.
|
|
275
|
+
6. Produce the user-facing output at:
|
|
276
|
+
- \`.docs/plan/plan.docx\` for document-style plan output, or
|
|
277
|
+
- \`.docs/plan/plan.xlsx\` for spreadsheet-style plan output
|
|
278
|
+
7. Assume Node.js export scripts will later convert structured content and templates into the final output format.
|
|
279
|
+
8. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
280
|
+
9. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
281
|
+
10. Ask the user before running any \`npm install\`.
|
|
282
|
+
11. Include phases, milestones, dependencies, assumptions, risks, and sequencing.
|
|
283
|
+
12. If relevant source material is outside \`.agentic/workspace/project/\`, move or organize it into the workspace by default unless the user explicitly says not to.
|
|
284
|
+
13. If planning inputs are missing, ask focused questions and keep refining instead of routing.
|
|
285
|
+
|
|
286
|
+
When the plan is complete enough, tell the user the available next options:
|
|
287
|
+
|
|
288
|
+
- \`@.agentic/commands/architecture.md\`
|
|
289
|
+
- \`@.agentic/commands/create-tasks.md\`
|
|
290
|
+
- \`@.agentic/commands/create-brd.md\`
|
|
291
|
+
- \`@.agentic/commands/create-proposal.md\`
|
|
292
|
+
`,".agentic/commands/create-tasks.md":`# Create Tasks
|
|
293
|
+
|
|
294
|
+
Read:
|
|
301
295
|
|
|
302
|
-
|
|
303
|
-
|
|
296
|
+
- \`@.agentic/context.md\`
|
|
297
|
+
- \`.agentic/workspace/memory/project-overview.md\`
|
|
298
|
+
- \`.agentic/workspace/memory/requirements.md\`
|
|
299
|
+
- \`.agentic/workspace/memory/architecture.md\` if it exists
|
|
300
|
+
- \`.agentic/workspace/documents/plan.*\` if it exists
|
|
301
|
+
- \`.agentic/workspace/documents/brd.*\` if it exists
|
|
302
|
+
- \`.agentic/workspace/documents/frd.*\` if it exists
|
|
303
|
+
- relevant files under \`.agentic/workspace/project/\`
|
|
304
|
+
|
|
305
|
+
## Your job
|
|
306
|
+
|
|
307
|
+
1. Maintain any internal draft content under \`.agentic/workspace/documents/tasks.*\` if useful.
|
|
308
|
+
2. Produce the user-facing task breakdown at \`.docs/tasks/tasks.xlsx\`.
|
|
309
|
+
3. Assume Node.js export scripts will later convert structured content and templates into the final \`.xlsx\`.
|
|
310
|
+
4. If the user already provided a template file/path/reference, follow it.
|
|
311
|
+
5. Otherwise ask whether they want a specific task breakdown style or structure.
|
|
312
|
+
6. If neither a template nor a style is provided, use the built-in default structure.
|
|
313
|
+
7. If export dependencies are needed, first check whether the target project root already has a usable Node environment.
|
|
314
|
+
8. Prefer the project root if it is suitable; otherwise ask the user which path should receive the install.
|
|
315
|
+
9. Ask the user before running any \`npm install\`.
|
|
316
|
+
10. Produce a practical task breakdown with modules, roles, dependencies, sequencing, and status placeholders.
|
|
317
|
+
11. If relevant source material is outside \`.agentic/workspace/project/\`, move or organize it into the workspace by default unless the user explicitly says not to.
|
|
318
|
+
12. If execution detail is missing, ask focused questions and keep refining instead of routing.
|
|
319
|
+
|
|
320
|
+
When the tasks are complete enough, tell the user the available next options:
|
|
321
|
+
|
|
322
|
+
- \`@.agentic/commands/create-plan.md\`
|
|
323
|
+
- \`@.agentic/commands/create-proposal.md\`
|
|
324
|
+
- \`@.agentic/commands/create-brd.md\`
|
|
325
|
+
`};var w={".agentic/init.md":`# Init
|
|
326
|
+
|
|
327
|
+
Read \`@.agentic/context.md\` first.
|
|
328
|
+
|
|
329
|
+
You are starting a fresh AI session inside this project. Your job is to quickly understand what this project is, what context already exists, and what the user still needs to provide.
|
|
330
|
+
|
|
331
|
+
## Read Scope
|
|
332
|
+
|
|
333
|
+
1. Read only root-level files and folders in the current project.
|
|
334
|
+
2. Do not recursively inspect the full repository.
|
|
335
|
+
3. Treat \`.agentic/\` as the exception:
|
|
336
|
+
- inspect \`.agentic/workspace/project/\`
|
|
337
|
+
- inspect \`.agentic/workspace/memory/\`
|
|
338
|
+
- inspect \`.agentic/workspace/documents/\`
|
|
339
|
+
4. Use existing workspace context if it is already present.
|
|
340
|
+
|
|
341
|
+
## Response Style
|
|
342
|
+
|
|
343
|
+
1. Be concise and synthesis-first.
|
|
344
|
+
2. Do not dump a full file inventory unless the user explicitly asks.
|
|
345
|
+
3. Do not mirror the prompt structure back to the user.
|
|
346
|
+
4. Respond with either:
|
|
347
|
+
- a short synthesized summary of what you understand, or
|
|
348
|
+
- a few focused questions if important context is still missing
|
|
349
|
+
|
|
350
|
+
## What To Do
|
|
351
|
+
|
|
352
|
+
1. Infer what kind of project this is from the root-level signals.
|
|
353
|
+
2. Check whether \`.agentic/workspace/project/\`, \`.agentic/workspace/memory/\`, and \`.agentic/workspace/documents/\` already contain useful context.
|
|
354
|
+
3. Build the best current understanding from:
|
|
355
|
+
- root-level signals
|
|
356
|
+
- existing workspace files
|
|
357
|
+
- the user's message in this chat
|
|
358
|
+
4. If project context is thin, ask a small number of targeted questions about:
|
|
359
|
+
- project goal
|
|
360
|
+
- target users
|
|
361
|
+
- scope or modules
|
|
362
|
+
- available references such as screenshots, docs, notes, links, or file paths
|
|
363
|
+
- desired outputs
|
|
364
|
+
5. If enough context exists, give a short summary of the project and the most important missing pieces.
|
|
365
|
+
6. If the user mentions screenshots, notes, requirement docs, links, or file paths, move or organize them into \`.agentic/workspace/project/\` by default unless the user explicitly says not to.
|
|
366
|
+
7. After the first useful exchange, create or update:
|
|
367
|
+
- \`.agentic/workspace/memory/project-overview.md\`
|
|
368
|
+
- \`.agentic/workspace/memory/requirements.md\`
|
|
369
|
+
- \`.agentic/workspace/memory/open-questions.md\`
|
|
370
|
+
8. Write drafts even from partial information.
|
|
371
|
+
9. Clearly separate confirmed facts, assumptions, and open questions.
|
|
372
|
+
10. Do not route immediately just because the workspace is empty. Do useful synthesis or ask focused questions first.
|
|
373
|
+
11. If important project basics are still missing, continue asking focused questions and keep updating the memory files instead of routing forward yet.
|
|
374
|
+
12. Only when you have done enough useful intake work to create a solid initial understanding, end with:
|
|
375
|
+
|
|
376
|
+
\`Next type @.agentic/commands/project-requirements.md\`
|
|
377
|
+
`,".agentic/context.md":`# Context
|
|
378
|
+
|
|
379
|
+
This repository uses a prompt-based project kick-off system.
|
|
380
|
+
|
|
381
|
+
## Folder Map
|
|
382
|
+
|
|
383
|
+
- \`.agentic/init.md\`: session bootstrap prompt
|
|
384
|
+
- \`.agentic/context.md\`: shared rules and folder semantics
|
|
385
|
+
- \`.agentic/commands/\`: prompt files for distinct tasks
|
|
386
|
+
- \`.agentic/workspace/project/\`: raw project materials
|
|
387
|
+
- \`.agentic/workspace/memory/\`: evolving AI-maintained understanding
|
|
388
|
+
- \`.agentic/workspace/documents/\`: internal drafts and intermediate artifacts
|
|
389
|
+
- \`.agentic/workspace/scripts/\`: optional Node export helpers
|
|
390
|
+
- \`.docs/\`: user-facing deliverables
|
|
391
|
+
|
|
392
|
+
## Workspace Semantics
|
|
393
|
+
|
|
394
|
+
### Project
|
|
395
|
+
|
|
396
|
+
Use \`.agentic/workspace/project/\` for:
|
|
397
|
+
|
|
398
|
+
- Figma screenshots
|
|
399
|
+
- requirement notes
|
|
400
|
+
- requirement documents
|
|
401
|
+
- links captured into markdown files
|
|
402
|
+
- user-supplied project references
|
|
403
|
+
|
|
404
|
+
If relevant project materials are found outside this folder, move or organize them into \`.agentic/workspace/project/\` by default. Only leave them in place if the user explicitly says not to move them.
|
|
405
|
+
|
|
406
|
+
### Memory
|
|
407
|
+
|
|
408
|
+
Use \`.agentic/workspace/memory/\` for:
|
|
409
|
+
|
|
410
|
+
- \`project-overview.md\`
|
|
411
|
+
- \`requirements.md\`
|
|
412
|
+
- \`open-questions.md\`
|
|
413
|
+
- \`architecture.md\`
|
|
414
|
+
- assumptions and structured working memory
|
|
415
|
+
|
|
416
|
+
### Internal Documents
|
|
417
|
+
|
|
418
|
+
Use \`.agentic/workspace/documents/\` for internal drafts or intermediate artifacts such as:
|
|
419
|
+
|
|
420
|
+
- draft BRD content
|
|
421
|
+
- draft FRD content
|
|
422
|
+
- draft estimate content
|
|
423
|
+
- draft proposal content
|
|
424
|
+
- draft plan content
|
|
425
|
+
- draft task breakdowns
|
|
426
|
+
|
|
427
|
+
### Scripts
|
|
428
|
+
|
|
429
|
+
Use \`.agentic/workspace/scripts/\` for optional Node.js export helpers.
|
|
430
|
+
|
|
431
|
+
Planned library stack:
|
|
432
|
+
|
|
433
|
+
- \`docx\` for \`.docx\`
|
|
434
|
+
- \`pptxgenjs\` for \`.pptx\`
|
|
435
|
+
- \`exceljs\` for \`.xlsx\`
|
|
436
|
+
|
|
437
|
+
Install behavior:
|
|
438
|
+
|
|
439
|
+
1. Check whether the target project root already has a usable Node environment.
|
|
440
|
+
2. Prefer installing there if suitable.
|
|
441
|
+
3. If root is not suitable or is ambiguous, ask the user which path should receive the install.
|
|
442
|
+
4. Ask the user before running any \`npm install\`.
|
|
443
|
+
|
|
444
|
+
### User Outputs
|
|
445
|
+
|
|
446
|
+
Use \`.docs/\` for user-facing deliverables:
|
|
447
|
+
|
|
448
|
+
- \`.docs/brd/brd.docx\`
|
|
449
|
+
- \`.docs/frd/frd.docx\`
|
|
450
|
+
- \`.docs/estimate/estimate.xlsx\`
|
|
451
|
+
- \`.docs/proposal/proposal.pptx\`
|
|
452
|
+
- \`.docs/plan/plan.docx\` or \`.docs/plan/plan.xlsx\`
|
|
453
|
+
- \`.docs/tasks/tasks.xlsx\`
|
|
454
|
+
|
|
455
|
+
## Working Rules
|
|
456
|
+
|
|
457
|
+
1. Reuse and improve existing workspace files when they already exist.
|
|
458
|
+
2. Do not scan the whole repository unless the user explicitly asks.
|
|
459
|
+
3. If relevant project assets are outside \`.agentic/workspace/project/\`, move them into the workspace by default and then use the workspace copy.
|
|
460
|
+
4. Only avoid moving files when the user explicitly asks to keep them in place.
|
|
461
|
+
5. Keep internal working material in \`.agentic/workspace/\` and user-facing deliverables in \`.docs/\`.
|
|
462
|
+
6. Prefer the target project root for Node-based export dependencies when a usable Node setup already exists there.
|
|
463
|
+
7. If root is not suitable, ask the user which path should be used for dependency installation.
|
|
464
|
+
8. Ask the user before running any install command.
|
|
465
|
+
9. Ask only the minimum blocking questions required to continue.
|
|
466
|
+
10. Always end by telling the user the exact next command to run or listing the available next options.
|
|
467
|
+
`};var d=[".agentic"],l=[".agentic",".agentic/commands",".agentic/workspace",".agentic/workspace/project",".agentic/workspace/memory",".agentic/workspace/documents",".agentic/workspace/scripts",".docs",".docs/brd",".docs/frd",".docs/estimate",".docs/proposal",".docs/plan",".docs/tasks"];var y={".agentic/workspace/scripts/README.md":"# Export Scripts\n\nThis folder is reserved for optional Node.js export helpers that will later generate user-facing deliverables in `.docs/`.\n\n## Planned Libraries\n\n- `docx` for `.docx`\n- `pptxgenjs` for `.pptx`\n- `exceljs` for `.xlsx`\n\n## Install Strategy\n\n1. Check whether the target project root already has a usable Node environment.\n2. Prefer installing export dependencies there if suitable.\n3. If root is not suitable or is ambiguous, ask the user which path should receive the install.\n4. Ask the user before running any `npm install`.\n\n## Planned Outputs\n\n- BRD: `.docs/brd/brd.docx`\n- FRD: `.docs/frd/frd.docx`\n- Estimate: `.docs/estimate/estimate.xlsx`\n- Proposal: `.docs/proposal/proposal.pptx`\n- Plan: `.docs/plan/plan.docx` or `.docs/plan/plan.xlsx`\n- Tasks: `.docs/tasks/tasks.xlsx`\n\nThese scripts are placeholders for now. They define the intended contract but do not perform real generation yet.\n",".agentic/workspace/scripts/generate_brd.js":`#!/usr/bin/env node
|
|
468
|
+
|
|
469
|
+
console.error("generate_brd.js is not implemented yet.");
|
|
470
|
+
console.error("Intended output: .docs/brd/brd.docx");
|
|
471
|
+
console.error("Planned library: docx");
|
|
472
|
+
process.exit(1);
|
|
473
|
+
`,".agentic/workspace/scripts/generate_frd.js":`#!/usr/bin/env node
|
|
474
|
+
|
|
475
|
+
console.error("generate_frd.js is not implemented yet.");
|
|
476
|
+
console.error("Intended output: .docs/frd/frd.docx");
|
|
477
|
+
console.error("Planned library: docx");
|
|
478
|
+
process.exit(1);
|
|
479
|
+
`,".agentic/workspace/scripts/generate_estimate.js":`#!/usr/bin/env node
|
|
480
|
+
|
|
481
|
+
console.error("generate_estimate.js is not implemented yet.");
|
|
482
|
+
console.error("Intended output: .docs/estimate/estimate.xlsx");
|
|
483
|
+
console.error("Planned library: exceljs");
|
|
484
|
+
process.exit(1);
|
|
485
|
+
`,".agentic/workspace/scripts/generate_proposal.js":`#!/usr/bin/env node
|
|
486
|
+
|
|
487
|
+
console.error("generate_proposal.js is not implemented yet.");
|
|
488
|
+
console.error("Intended output: .docs/proposal/proposal.pptx");
|
|
489
|
+
console.error("Planned library: pptxgenjs");
|
|
490
|
+
process.exit(1);
|
|
491
|
+
`,".agentic/workspace/scripts/generate_plan.js":`#!/usr/bin/env node
|
|
492
|
+
|
|
493
|
+
console.error("generate_plan.js is not implemented yet.");
|
|
494
|
+
console.error("Intended outputs: .docs/plan/plan.docx or .docs/plan/plan.xlsx");
|
|
495
|
+
console.error("Planned libraries: docx or exceljs");
|
|
496
|
+
process.exit(1);
|
|
497
|
+
`,".agentic/workspace/scripts/generate_tasks.js":`#!/usr/bin/env node
|
|
498
|
+
|
|
499
|
+
console.error("generate_tasks.js is not implemented yet.");
|
|
500
|
+
console.error("Intended output: .docs/tasks/tasks.xlsx");
|
|
501
|
+
console.error("Planned library: exceljs");
|
|
502
|
+
process.exit(1);
|
|
503
|
+
`};var x=()=>({...w,...k,...y});async function P(e){await Promise.all(d.map(t=>A(p.join(e,t),{recursive:!0,force:!0})))}async function E(e){await Promise.all(l.map(t=>R(p.join(e,t),{recursive:!0})))}async function N(e){let t=x();await Promise.all(Object.entries(t).map(([s,r])=>q(p.join(e,s),r,"utf8")))}async function T(){let e=process.cwd();await P(e),await E(e),await N(e),await h(e,f,g,i,c),console.log(""),console.log("create-agentic-starter: scaffold created successfully."),console.log(`Project folder: ${e}`),console.log(""),console.log("Next steps:"),console.log("1. Open your AI tool in this folder."),console.log("2. Start a new chat with @.agentic/init.md"),console.log("")}T().catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(`create-agentic-starter: failed to scaffold project. ${t}`),process.exitCode=1});
|