create-agentic-starter 0.1.4 → 0.1.5
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 +2 -2
- package/dist/index.js +49 -44
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,8 +28,8 @@ Run the command inside an existing project folder.
|
|
|
28
28
|
The scaffold is non-interactive. It will:
|
|
29
29
|
|
|
30
30
|
- recreate `.agentic/`
|
|
31
|
-
-
|
|
32
|
-
-
|
|
31
|
+
- preserve existing `AGENTS.md` and `.gitignore`, appending a marked `create-agentic-starter` section when needed
|
|
32
|
+
- never modify `README.md`
|
|
33
33
|
- print the next step for the team
|
|
34
34
|
|
|
35
35
|
## Generated Structure
|
package/dist/index.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{mkdir as
|
|
2
|
+
import{mkdir as f,readFile as w,rm as k,writeFile as c}from"fs/promises";import i from"path";var y="AGENTS.md",j=".gitignore",p="<!-- from create-agentic-starter:agents:start -->",u="<!-- from create-agentic-starter:agents:end -->",l="# from create-agentic-starter:start",g="# from create-agentic-starter:end",x=[".agentic"],v=()=>({".agentic/init.md":`# Init
|
|
3
3
|
|
|
4
4
|
Read \`@.agentic/context.md\` first.
|
|
5
5
|
|
|
6
|
-
You are starting a fresh AI session inside this project. Your job is to
|
|
6
|
+
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.
|
|
7
7
|
|
|
8
8
|
## Read Scope
|
|
9
9
|
|
|
@@ -15,18 +15,39 @@ You are starting a fresh AI session inside this project. Your job is to build li
|
|
|
15
15
|
- inspect \`.agentic/workspace/documents/\`
|
|
16
16
|
4. Use existing workspace context if it is already present.
|
|
17
17
|
|
|
18
|
+
## Response Style
|
|
19
|
+
|
|
20
|
+
1. Be concise and synthesis-first.
|
|
21
|
+
2. Do not dump a full file inventory unless the user explicitly asks.
|
|
22
|
+
3. Do not mirror the prompt structure back to the user.
|
|
23
|
+
4. Respond with either:
|
|
24
|
+
- a short synthesized summary of what you understand, or
|
|
25
|
+
- a few focused questions if important context is still missing
|
|
26
|
+
|
|
18
27
|
## What To Do
|
|
19
28
|
|
|
20
|
-
1.
|
|
21
|
-
2.
|
|
22
|
-
3. Build
|
|
23
|
-
- root-level
|
|
29
|
+
1. Infer what kind of project this is from the root-level signals.
|
|
30
|
+
2. Check whether \`.agentic/workspace/project/\`, \`.agentic/workspace/memory/\`, and \`.agentic/workspace/documents/\` already contain useful context.
|
|
31
|
+
3. Build the best current understanding from:
|
|
32
|
+
- root-level signals
|
|
24
33
|
- existing workspace files
|
|
25
34
|
- the user's message in this chat
|
|
26
|
-
4. If
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
35
|
+
4. If project context is thin, ask a small number of targeted questions about:
|
|
36
|
+
- project goal
|
|
37
|
+
- target users
|
|
38
|
+
- scope or modules
|
|
39
|
+
- available references such as screenshots, docs, notes, links, or file paths
|
|
40
|
+
- desired outputs
|
|
41
|
+
5. If enough context exists, give a short summary of the project and the most important missing pieces.
|
|
42
|
+
6. If the user mentions screenshots, notes, requirement docs, links, or file paths, tell them how those should be placed or referenced under \`.agentic/workspace/project/\`.
|
|
43
|
+
7. After the first useful exchange, create or update:
|
|
44
|
+
- \`.agentic/workspace/memory/project-overview.md\`
|
|
45
|
+
- \`.agentic/workspace/memory/requirements.md\`
|
|
46
|
+
- \`.agentic/workspace/memory/open-questions.md\`
|
|
47
|
+
8. Write drafts even from partial information.
|
|
48
|
+
9. Clearly separate confirmed facts, assumptions, and open questions.
|
|
49
|
+
10. Do not route immediately just because the workspace is empty. Do useful synthesis or ask focused questions first.
|
|
50
|
+
11. Once you have done useful intake work, end with:
|
|
30
51
|
|
|
31
52
|
\`Next type @.agentic/commands/project-requirements.md\`
|
|
32
53
|
`,".agentic/context.md":`# Context
|
|
@@ -91,17 +112,20 @@ Read:
|
|
|
91
112
|
|
|
92
113
|
## Your job
|
|
93
114
|
|
|
94
|
-
1.
|
|
95
|
-
2.
|
|
115
|
+
1. Refine and deepen the initial understanding created during \`@.agentic/init.md\`.
|
|
116
|
+
2. Collect any missing project explanation, goals, users, scope, screenshots, references, and known deliverables.
|
|
117
|
+
3. Accept either:
|
|
96
118
|
- existing file paths already shared by the user, or
|
|
97
119
|
- fresh explanation typed in chat
|
|
98
|
-
|
|
99
|
-
|
|
120
|
+
4. Tell the user where each input belongs under \`.agentic/workspace/project/\`.
|
|
121
|
+
5. Organize and normalize the project context so the later architecture and document steps can rely on it.
|
|
122
|
+
6. Create or update:
|
|
100
123
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
101
124
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
102
125
|
- \`.agentic/workspace/memory/open-questions.md\`
|
|
103
|
-
|
|
104
|
-
|
|
126
|
+
7. Capture assumptions separately from confirmed facts.
|
|
127
|
+
8. Reduce open questions where possible before handing off to architecture.
|
|
128
|
+
9. Ask only for missing details that block useful requirement understanding.
|
|
105
129
|
|
|
106
130
|
When done, tell the user:
|
|
107
131
|
|
|
@@ -210,7 +234,7 @@ Read:
|
|
|
210
234
|
4. Ask only the minimum blocking questions.
|
|
211
235
|
|
|
212
236
|
When done, tell the user the v1 workflow is complete and list the generated files.
|
|
213
|
-
`}),
|
|
237
|
+
`}),b=`${p}
|
|
214
238
|
# Agentic Starter Guide
|
|
215
239
|
|
|
216
240
|
This project includes a reusable AI working area under \`.agentic/\` for project kick-off and pre-delivery documentation.
|
|
@@ -249,35 +273,16 @@ Use this scaffold when you want an AI tool to:
|
|
|
249
273
|
7. \`@.agentic/commands/create-proposal.md\`
|
|
250
274
|
|
|
251
275
|
If your tool does not support \`@file\` references, paste the contents of the prompt file into a new chat manually.
|
|
252
|
-
${
|
|
253
|
-
`,q=`${
|
|
254
|
-
## Agentic Starter
|
|
255
|
-
|
|
256
|
-
This project includes a reusable AI workflow scaffold under \`.agentic/\`.
|
|
257
|
-
|
|
258
|
-
Start every new AI session with:
|
|
259
|
-
|
|
260
|
-
\`@.agentic/init.md\`
|
|
261
|
-
|
|
262
|
-
Command flow:
|
|
263
|
-
|
|
264
|
-
1. \`@.agentic/init.md\`
|
|
265
|
-
2. \`@.agentic/commands/project-requirements.md\`
|
|
266
|
-
3. \`@.agentic/commands/architecture.md\`
|
|
267
|
-
4. \`@.agentic/commands/create-brd.md\`
|
|
268
|
-
5. \`@.agentic/commands/create-frd.md\`
|
|
269
|
-
6. \`@.agentic/commands/create-estimate.md\`
|
|
270
|
-
7. \`@.agentic/commands/create-proposal.md\`
|
|
271
|
-
${g}
|
|
272
|
-
`,T=`${w}
|
|
276
|
+
${u}
|
|
277
|
+
`,q=`${l}
|
|
273
278
|
.agentic/workspace/documents/
|
|
274
279
|
.agentic/workspace/memory/
|
|
275
|
-
${
|
|
276
|
-
`,
|
|
277
|
-
`);let
|
|
280
|
+
${g}
|
|
281
|
+
`,R=[".agentic",".agentic/commands",".agentic/workspace",".agentic/workspace/project",".agentic/workspace/memory",".agentic/workspace/documents"];async function A(e){await Promise.all(x.map(t=>k(i.join(e,t),{recursive:!0,force:!0})))}async function E(e){await Promise.all(R.map(t=>f(i.join(e,t),{recursive:!0})))}async function I(e){let t=v();await Promise.all(Object.entries(t).map(([o,n])=>c(i.join(e,o),n,"utf8")))}function T(e,t,o,n){let s=new RegExp(`${m(o)}[\\s\\S]*?${m(n)}\\n?`,"m");if(s.test(e))return e.replace(s,`${t}
|
|
282
|
+
`);let r=e.endsWith(`
|
|
278
283
|
`)?`
|
|
279
284
|
`:`
|
|
280
285
|
|
|
281
|
-
`;return`${e}${
|
|
282
|
-
`}function
|
|
283
|
-
`,"utf8")}}async function
|
|
286
|
+
`;return`${e}${r}${t}
|
|
287
|
+
`}function m(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}async function d(e,t,o,n,s){let r=i.join(e,t);try{let a=await w(r,"utf8"),h=T(a,o,n,s);await c(r,h,"utf8")}catch(a){if(a.code!=="ENOENT")throw a;await c(r,`${o}
|
|
288
|
+
`,"utf8")}}async function N(){let e=process.cwd();await A(e),await E(e),await I(e),await d(e,y,b,p,u),await d(e,j,q,l,g),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("")}N().catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(`create-agentic-starter: failed to scaffold project. ${t}`),process.exitCode=1});
|