create-agentic-starter 0.1.3 → 0.1.4
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 +48 -46
- 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
|
+
- recreate `AGENTS.md`
|
|
32
|
+
- preserve existing `README.md` and `.gitignore`, appending a marked `create-agentic-starter` section at the end
|
|
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,43 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{mkdir 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 k,readFile as y,rm as j,writeFile as m}from"fs/promises";import i from"path";var v="AGENTS.md",x="README.md",A=".gitignore",p="<!-- from create-agentic-starter:agents:start -->",l="<!-- from create-agentic-starter:agents:end -->",u="<!-- from create-agentic-starter:start -->",g="<!-- from create-agentic-starter:end -->",w="# from create-agentic-starter:start",f="# from create-agentic-starter:end",b=[".agentic"],R=()=>({".agentic/init.md":`# Init
|
|
41
3
|
|
|
42
4
|
Read \`@.agentic/context.md\` first.
|
|
43
5
|
|
|
@@ -248,7 +210,47 @@ Read:
|
|
|
248
210
|
4. Ask only the minimum blocking questions.
|
|
249
211
|
|
|
250
212
|
When done, tell the user the v1 workflow is complete and list the generated files.
|
|
251
|
-
`}),
|
|
213
|
+
`}),E=`${p}
|
|
214
|
+
# Agentic Starter Guide
|
|
215
|
+
|
|
216
|
+
This project includes a reusable AI working area under \`.agentic/\` for project kick-off and pre-delivery documentation.
|
|
217
|
+
|
|
218
|
+
## What This Is For
|
|
219
|
+
|
|
220
|
+
Use this scaffold when you want an AI tool to:
|
|
221
|
+
|
|
222
|
+
- understand a project from files, notes, screenshots, and links
|
|
223
|
+
- maintain structured project memory
|
|
224
|
+
- generate markdown deliverables such as BRD, FRD, estimate, and proposal
|
|
225
|
+
|
|
226
|
+
## Folder Purpose
|
|
227
|
+
|
|
228
|
+
- \`.agentic/init.md\`: first prompt for every new AI session
|
|
229
|
+
- \`.agentic/context.md\`: shared rules and folder map
|
|
230
|
+
- \`.agentic/commands/\`: task-specific prompt files you reference in your AI tool
|
|
231
|
+
- \`.agentic/workspace/project/\`: raw project inputs such as screenshots, notes, requirement docs, and reference links
|
|
232
|
+
- \`.agentic/workspace/memory/\`: evolving AI-maintained project understanding
|
|
233
|
+
- \`.agentic/workspace/documents/\`: polished markdown deliverables
|
|
234
|
+
|
|
235
|
+
## How To Use It
|
|
236
|
+
|
|
237
|
+
1. Open your AI tool in this project.
|
|
238
|
+
2. Start every new session with \`@.agentic/init.md\`.
|
|
239
|
+
3. Follow the command sequence below.
|
|
240
|
+
|
|
241
|
+
## V1 Command Sequence
|
|
242
|
+
|
|
243
|
+
1. \`@.agentic/init.md\`
|
|
244
|
+
2. \`@.agentic/commands/project-requirements.md\`
|
|
245
|
+
3. \`@.agentic/commands/architecture.md\`
|
|
246
|
+
4. \`@.agentic/commands/create-brd.md\`
|
|
247
|
+
5. \`@.agentic/commands/create-frd.md\`
|
|
248
|
+
6. \`@.agentic/commands/create-estimate.md\`
|
|
249
|
+
7. \`@.agentic/commands/create-proposal.md\`
|
|
250
|
+
|
|
251
|
+
If your tool does not support \`@file\` references, paste the contents of the prompt file into a new chat manually.
|
|
252
|
+
${l}
|
|
253
|
+
`,q=`${u}
|
|
252
254
|
## Agentic Starter
|
|
253
255
|
|
|
254
256
|
This project includes a reusable AI workflow scaffold under \`.agentic/\`.
|
|
@@ -266,16 +268,16 @@ Command flow:
|
|
|
266
268
|
5. \`@.agentic/commands/create-frd.md\`
|
|
267
269
|
6. \`@.agentic/commands/create-estimate.md\`
|
|
268
270
|
7. \`@.agentic/commands/create-proposal.md\`
|
|
269
|
-
${
|
|
270
|
-
`,
|
|
271
|
+
${g}
|
|
272
|
+
`,T=`${w}
|
|
271
273
|
.agentic/workspace/documents/
|
|
272
274
|
.agentic/workspace/memory/
|
|
273
|
-
${
|
|
274
|
-
`,
|
|
275
|
+
${f}
|
|
276
|
+
`,I=[".agentic",".agentic/commands",".agentic/workspace",".agentic/workspace/project",".agentic/workspace/memory",".agentic/workspace/documents"];async function S(e){await Promise.all(b.map(t=>j(i.join(e,t),{recursive:!0,force:!0})))}async function N(e){await Promise.all(I.map(t=>k(i.join(e,t),{recursive:!0})))}async function P(e){let t=R();await Promise.all(Object.entries(t).map(([r,n])=>m(i.join(e,r),n,"utf8")))}function D(e,t,r,n){let a=new RegExp(`${d(r)}[\\s\\S]*?${d(n)}\\n?`,"m");if(a.test(e))return e.replace(a,`${t}
|
|
275
277
|
`);let o=e.endsWith(`
|
|
276
278
|
`)?`
|
|
277
279
|
`:`
|
|
278
280
|
|
|
279
281
|
`;return`${e}${o}${t}
|
|
280
|
-
`}function
|
|
281
|
-
`,"utf8")}}async function
|
|
282
|
+
`}function d(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}async function c(e,t,r,n,a){let o=i.join(e,t);try{let s=await y(o,"utf8"),h=D(s,r,n,a);await m(o,h,"utf8")}catch(s){if(s.code!=="ENOENT")throw s;await m(o,`${r}
|
|
283
|
+
`,"utf8")}}async function M(){let e=process.cwd();await S(e),await N(e),await P(e),await c(e,v,E,p,l),await c(e,x,q,u,g),await c(e,A,T,w,f),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("")}M().catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(`create-agentic-starter: failed to scaffold project. ${t}`),process.exitCode=1});
|