create-agentic-starter 0.1.3 → 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 +44 -2
- package/dist/index.js +73 -66
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,53 @@
|
|
|
1
1
|
# create-agentic-starter
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`create-agentic-starter` scaffolds a lightweight `.agentic/` workspace inside an existing project so AI tools can follow a repeatable kick-off workflow.
|
|
4
|
+
|
|
5
|
+
The goal is to avoid rebuilding the same project-start process every time. Instead of manually re-creating prompts and folders for every new client engagement, this package sets up a standard structure for:
|
|
6
|
+
|
|
7
|
+
- requirement gathering
|
|
8
|
+
- architecture thinking
|
|
9
|
+
- BRD generation
|
|
10
|
+
- FRD generation
|
|
11
|
+
- estimation
|
|
12
|
+
- proposal drafting
|
|
13
|
+
|
|
14
|
+
It is designed for prompt-driven AI tools. The generated scaffold gives each new session a clear entrypoint with `@.agentic/init.md`, a set of reusable prompts in `.agentic/commands/`, and a workspace for project assets, memory, and generated documents.
|
|
4
15
|
|
|
5
16
|
## Usage
|
|
6
17
|
|
|
18
|
+
```bash
|
|
19
|
+
npx create-agentic-starter
|
|
20
|
+
```
|
|
21
|
+
|
|
7
22
|
```bash
|
|
8
23
|
bunx create-agentic-starter
|
|
9
24
|
```
|
|
10
25
|
|
|
11
|
-
|
|
26
|
+
Run the command inside an existing project folder.
|
|
27
|
+
|
|
28
|
+
The scaffold is non-interactive. It will:
|
|
29
|
+
|
|
30
|
+
- recreate `.agentic/`
|
|
31
|
+
- preserve existing `AGENTS.md` and `.gitignore`, appending a marked `create-agentic-starter` section when needed
|
|
32
|
+
- never modify `README.md`
|
|
33
|
+
- print the next step for the team
|
|
34
|
+
|
|
35
|
+
## Generated Structure
|
|
36
|
+
|
|
37
|
+
The command sets up:
|
|
38
|
+
|
|
39
|
+
- `.agentic/init.md`
|
|
40
|
+
- `.agentic/context.md`
|
|
41
|
+
- `.agentic/commands/`
|
|
42
|
+
- `.agentic/workspace/project/`
|
|
43
|
+
- `.agentic/workspace/memory/`
|
|
44
|
+
- `.agentic/workspace/documents/`
|
|
45
|
+
- `AGENTS.md`
|
|
46
|
+
|
|
47
|
+
## First Run Flow
|
|
48
|
+
|
|
49
|
+
After scaffolding:
|
|
50
|
+
|
|
51
|
+
1. Open your AI tool in the project.
|
|
52
|
+
2. Start a new session with `@.agentic/init.md`.
|
|
53
|
+
3. Follow the command sequence defined in `AGENTS.md`.
|
package/dist/index.js
CHANGED
|
@@ -1,47 +1,9 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{mkdir as f,readFile as
|
|
3
|
-
|
|
4
|
-
This scaffold creates a reusable AI working area under \`.agentic/\` for project kick-off and pre-delivery documentation.
|
|
5
|
-
|
|
6
|
-
## What This Is For
|
|
7
|
-
|
|
8
|
-
Use this scaffold when you want an AI tool to:
|
|
9
|
-
|
|
10
|
-
- understand a project from files, notes, screenshots, and links
|
|
11
|
-
- maintain structured project memory
|
|
12
|
-
- generate markdown deliverables such as BRD, FRD, estimate, and proposal
|
|
13
|
-
|
|
14
|
-
## Folder Purpose
|
|
15
|
-
|
|
16
|
-
- \`.agentic/init.md\`: first prompt for every new AI session
|
|
17
|
-
- \`.agentic/context.md\`: shared rules and folder map
|
|
18
|
-
- \`.agentic/commands/\`: task-specific prompt files you reference in your AI tool
|
|
19
|
-
- \`.agentic/workspace/project/\`: raw project inputs such as screenshots, notes, requirement docs, and reference links
|
|
20
|
-
- \`.agentic/workspace/memory/\`: evolving AI-maintained project understanding
|
|
21
|
-
- \`.agentic/workspace/documents/\`: polished markdown deliverables
|
|
22
|
-
|
|
23
|
-
## How To Use It
|
|
24
|
-
|
|
25
|
-
1. Open your AI tool in this project.
|
|
26
|
-
2. Start every new session with \`@.agentic/init.md\`.
|
|
27
|
-
3. Follow the command sequence below.
|
|
28
|
-
|
|
29
|
-
## V1 Command Sequence
|
|
30
|
-
|
|
31
|
-
1. \`@.agentic/init.md\`
|
|
32
|
-
2. \`@.agentic/commands/project-requirements.md\`
|
|
33
|
-
3. \`@.agentic/commands/architecture.md\`
|
|
34
|
-
4. \`@.agentic/commands/create-brd.md\`
|
|
35
|
-
5. \`@.agentic/commands/create-frd.md\`
|
|
36
|
-
6. \`@.agentic/commands/create-estimate.md\`
|
|
37
|
-
7. \`@.agentic/commands/create-proposal.md\`
|
|
38
|
-
|
|
39
|
-
If your tool does not support \`@file\` references, paste the contents of the prompt file into a new chat manually.
|
|
40
|
-
`,".agentic/init.md":`# Init
|
|
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
|
|
41
3
|
|
|
42
4
|
Read \`@.agentic/context.md\` first.
|
|
43
5
|
|
|
44
|
-
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.
|
|
45
7
|
|
|
46
8
|
## Read Scope
|
|
47
9
|
|
|
@@ -53,18 +15,39 @@ You are starting a fresh AI session inside this project. Your job is to build li
|
|
|
53
15
|
- inspect \`.agentic/workspace/documents/\`
|
|
54
16
|
4. Use existing workspace context if it is already present.
|
|
55
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
|
+
|
|
56
27
|
## What To Do
|
|
57
28
|
|
|
58
|
-
1.
|
|
59
|
-
2.
|
|
60
|
-
3. Build
|
|
61
|
-
- 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
|
|
62
33
|
- existing workspace files
|
|
63
34
|
- the user's message in this chat
|
|
64
|
-
4. If
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
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:
|
|
68
51
|
|
|
69
52
|
\`Next type @.agentic/commands/project-requirements.md\`
|
|
70
53
|
`,".agentic/context.md":`# Context
|
|
@@ -129,17 +112,20 @@ Read:
|
|
|
129
112
|
|
|
130
113
|
## Your job
|
|
131
114
|
|
|
132
|
-
1.
|
|
133
|
-
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:
|
|
134
118
|
- existing file paths already shared by the user, or
|
|
135
119
|
- fresh explanation typed in chat
|
|
136
|
-
|
|
137
|
-
|
|
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:
|
|
138
123
|
- \`.agentic/workspace/memory/project-overview.md\`
|
|
139
124
|
- \`.agentic/workspace/memory/requirements.md\`
|
|
140
125
|
- \`.agentic/workspace/memory/open-questions.md\`
|
|
141
|
-
|
|
142
|
-
|
|
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.
|
|
143
129
|
|
|
144
130
|
When done, tell the user:
|
|
145
131
|
|
|
@@ -249,15 +235,34 @@ Read:
|
|
|
249
235
|
|
|
250
236
|
When done, tell the user the v1 workflow is complete and list the generated files.
|
|
251
237
|
`}),b=`${p}
|
|
252
|
-
|
|
238
|
+
# Agentic Starter Guide
|
|
239
|
+
|
|
240
|
+
This project includes a reusable AI working area under \`.agentic/\` for project kick-off and pre-delivery documentation.
|
|
241
|
+
|
|
242
|
+
## What This Is For
|
|
243
|
+
|
|
244
|
+
Use this scaffold when you want an AI tool to:
|
|
245
|
+
|
|
246
|
+
- understand a project from files, notes, screenshots, and links
|
|
247
|
+
- maintain structured project memory
|
|
248
|
+
- generate markdown deliverables such as BRD, FRD, estimate, and proposal
|
|
249
|
+
|
|
250
|
+
## Folder Purpose
|
|
253
251
|
|
|
254
|
-
|
|
252
|
+
- \`.agentic/init.md\`: first prompt for every new AI session
|
|
253
|
+
- \`.agentic/context.md\`: shared rules and folder map
|
|
254
|
+
- \`.agentic/commands/\`: task-specific prompt files you reference in your AI tool
|
|
255
|
+
- \`.agentic/workspace/project/\`: raw project inputs such as screenshots, notes, requirement docs, and reference links
|
|
256
|
+
- \`.agentic/workspace/memory/\`: evolving AI-maintained project understanding
|
|
257
|
+
- \`.agentic/workspace/documents/\`: polished markdown deliverables
|
|
255
258
|
|
|
256
|
-
|
|
259
|
+
## How To Use It
|
|
257
260
|
|
|
258
|
-
|
|
261
|
+
1. Open your AI tool in this project.
|
|
262
|
+
2. Start every new session with \`@.agentic/init.md\`.
|
|
263
|
+
3. Follow the command sequence below.
|
|
259
264
|
|
|
260
|
-
Command
|
|
265
|
+
## V1 Command Sequence
|
|
261
266
|
|
|
262
267
|
1. \`@.agentic/init.md\`
|
|
263
268
|
2. \`@.agentic/commands/project-requirements.md\`
|
|
@@ -266,16 +271,18 @@ Command flow:
|
|
|
266
271
|
5. \`@.agentic/commands/create-frd.md\`
|
|
267
272
|
6. \`@.agentic/commands/create-estimate.md\`
|
|
268
273
|
7. \`@.agentic/commands/create-proposal.md\`
|
|
269
|
-
|
|
270
|
-
|
|
274
|
+
|
|
275
|
+
If your tool does not support \`@file\` references, paste the contents of the prompt file into a new chat manually.
|
|
276
|
+
${u}
|
|
277
|
+
`,q=`${l}
|
|
271
278
|
.agentic/workspace/documents/
|
|
272
279
|
.agentic/workspace/memory/
|
|
273
280
|
${g}
|
|
274
|
-
`,R=[".agentic",".agentic/commands",".agentic/workspace",".agentic/workspace/project",".agentic/workspace/memory",".agentic/workspace/documents"];async function
|
|
275
|
-
`);let
|
|
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(`
|
|
276
283
|
`)?`
|
|
277
284
|
`:`
|
|
278
285
|
|
|
279
|
-
`;return`${e}${
|
|
280
|
-
`}function m(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}async function d(e,t,
|
|
281
|
-
`,"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});
|