create-agentic-starter 0.1.1

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.
Files changed (3) hide show
  1. package/README.md +11 -0
  2. package/dist/index.js +179 -0
  3. package/package.json +36 -0
package/README.md ADDED
@@ -0,0 +1,11 @@
1
+ # create-agentic-starter
2
+
3
+ Scaffolds a minimal AI-powered project delivery workflow into the current folder.
4
+
5
+ ## Usage
6
+
7
+ ```bash
8
+ bunx create-agentic-starter
9
+ ```
10
+
11
+ The command is non-interactive. It resets the generated scaffold paths, creates the `.agentic/` structure, and prints the next step for the team.
package/dist/index.js ADDED
@@ -0,0 +1,179 @@
1
+ #!/usr/bin/env node
2
+ import{mkdir as a,rm as r,writeFile as o}from"fs/promises";import n from"path";var c=[".agentic","workspace","AGENTS.md","README.md",".gitignore"],d=e=>({"README.md":`# ${n.basename(e)}
3
+
4
+ This project uses \`create-agentic-starter\` to standardize discovery, architecture, documentation, and estimation workflows.
5
+
6
+ ## Start Here
7
+
8
+ 1. Drop Figma or requirement screenshots into \`.agentic/workspace/requirements/figma-screenshots/\`.
9
+ 2. Open your AI tool in this folder.
10
+ 3. Start a new chat with \`@.agentic/init.md\`.
11
+
12
+ ## Flow
13
+
14
+ The scaffold guides the team through these steps:
15
+
16
+ 1. Project understanding
17
+ 2. Architecture
18
+ 3. BRD
19
+ 4. FRD
20
+ 5. Estimation
21
+ `,".gitignore":`.DS_Store
22
+ node_modules
23
+ dist
24
+ .agentic/workspace/analysis
25
+ .agentic/workspace/documents
26
+ `,"AGENTS.md":`# Agent Instructions
27
+
28
+ If your tool does not support \`@file\` references, start by pasting the contents of [./.agentic/init.md](./.agentic/init.md) into a new chat.
29
+
30
+ Core files:
31
+
32
+ - [./.agentic/init.md](./.agentic/init.md)
33
+ - [./.agentic/context.md](./.agentic/context.md)
34
+ - [./.agentic/instructions/01-project-understanding.md](./.agentic/instructions/01-project-understanding.md)
35
+ - [./.agentic/instructions/02-architecture.md](./.agentic/instructions/02-architecture.md)
36
+ - [./.agentic/instructions/03-brd.md](./.agentic/instructions/03-brd.md)
37
+ - [./.agentic/instructions/04-frd.md](./.agentic/instructions/04-frd.md)
38
+ - [./.agentic/instructions/05-estimation.md](./.agentic/instructions/05-estimation.md)
39
+ `,".agentic/init.md":`# Init
40
+
41
+ You are bootstrapping this project workspace.
42
+
43
+ ## Your job
44
+
45
+ 1. Read \`@.agentic/context.md\`.
46
+ 2. Scan the full \`.agentic/workspace/\` directory and summarize what already exists.
47
+ 3. Inspect \`.agentic/workspace/requirements/\` for screenshots, requirement notes, references, or client material.
48
+ 4. If \`.agentic/workspace/analysis/project-overview.md\` already exists, review and improve it instead of replacing useful content.
49
+ 5. If \`.agentic/workspace/analysis/architecture.md\` already exists, review and improve it instead of replacing useful content.
50
+ 6. Ask the user only for information that is truly missing and blocks accurate analysis.
51
+ 7. Create or update \`.agentic/workspace/analysis/project-overview.md\` with:
52
+ - project summary
53
+ - goals
54
+ - users or stakeholders
55
+ - major modules
56
+ - assumptions
57
+ - risks
58
+ - open questions
59
+ 8. Create or update \`.agentic/workspace/analysis/architecture.md\` with an initial architecture direction if enough information exists.
60
+ 9. End with a concise summary of what you found, what you created or updated, and tell the user:
61
+
62
+ \`Next type @.agentic/instructions/01-project-understanding.md\`
63
+ `,".agentic/context.md":"# Context Map\n\nThis repository is scaffolded for an AI-assisted delivery workflow.\n\n## Paths\n\n- `.agentic/init.md`: first prompt to run in a new chat.\n- `.agentic/context.md`: shared map every step should read before doing work.\n- `.agentic/instructions/`: ordered step prompts.\n- `.agentic/workspace/requirements/`: source inputs from client, discovery, screenshots, notes, and references.\n- `.agentic/workspace/requirements/figma-screenshots/`: raw Figma screenshots dropped by the team.\n- `.agentic/workspace/analysis/`: generated markdown outputs such as project understanding, architecture, BRD drafts, FRD drafts, and estimation notes.\n- `.agentic/workspace/documents/`: exported deliverables such as `.docx`, `.xlsx`, or PDFs.\n- `.agentic/workspace/code/`: implementation area for frontend, backend, shared packages, and related codebases.\n- `.agentic/workspace/scripts/`: helper generators such as BRD or estimation export scripts.\n\n## Working rules\n\n1. Always read this file before executing an instruction step.\n2. Reuse and improve existing files when present instead of blindly overwriting good work.\n3. Save outputs only in the folders described above.\n4. At the end of every step, tell the user the exact next prompt to run.\n",".agentic/instructions/01-project-understanding.md":`# Step 01: Project Understanding
64
+
65
+ Read:
66
+
67
+ - \`@.agentic/context.md\`
68
+ - \`@.agentic/workspace/analysis/project-overview.md\` if it exists
69
+ - everything relevant inside \`@.agentic/workspace/requirements/\`
70
+
71
+ Your job:
72
+
73
+ 1. Build a clear understanding of the project scope from the available inputs.
74
+ 2. Identify business goal, target users, core workflows, major features, dependencies, constraints, assumptions, and risks.
75
+ 3. Update or create \`.agentic/workspace/analysis/project-overview.md\` as a polished project-understanding document.
76
+ 4. Keep the document practical and client-ready.
77
+ 5. If information is missing, ask only the minimum blocking questions.
78
+
79
+ Output file:
80
+
81
+ - \`.agentic/workspace/analysis/project-overview.md\`
82
+
83
+ When done, tell the user:
84
+
85
+ \`Next type @.agentic/instructions/02-architecture.md\`
86
+ `,".agentic/instructions/02-architecture.md":`# Step 02: Architecture
87
+
88
+ Read:
89
+
90
+ - \`@.agentic/context.md\`
91
+ - \`@.agentic/workspace/analysis/project-overview.md\`
92
+ - any relevant requirement material in \`@.agentic/workspace/requirements/\`
93
+
94
+ Your job:
95
+
96
+ 1. Define the recommended system architecture for this project.
97
+ 2. Cover frontend, backend, data, integrations, authentication, deployment, observability, and security where relevant.
98
+ 3. Include a mermaid diagram if the AI tool supports it.
99
+ 4. Update or create \`.agentic/workspace/analysis/architecture.md\`.
100
+ 5. Keep it implementation-oriented and aligned with the project scope.
101
+
102
+ Output file:
103
+
104
+ - \`.agentic/workspace/analysis/architecture.md\`
105
+
106
+ When done, tell the user:
107
+
108
+ \`Next type @.agentic/instructions/03-brd.md\`
109
+ `,".agentic/instructions/03-brd.md":`# Step 03: BRD
110
+
111
+ Read:
112
+
113
+ - \`@.agentic/context.md\`
114
+ - \`@.agentic/workspace/analysis/project-overview.md\`
115
+ - \`@.agentic/workspace/analysis/architecture.md\`
116
+ - any supporting requirement files in \`@.agentic/workspace/requirements/\`
117
+
118
+ Your job:
119
+
120
+ 1. Create a Business Requirements Document based on the available context.
121
+ 2. Cover executive summary, business goals, problem statement, users, scope, assumptions, dependencies, risks, milestones, and acceptance framing.
122
+ 3. Save the markdown draft to \`.agentic/workspace/analysis/brd.md\`.
123
+ 4. If a generator script exists in \`.agentic/workspace/scripts/\`, mention whether it can be used to export a \`.docx\` into \`.agentic/workspace/documents/\`.
124
+
125
+ Output file:
126
+
127
+ - \`.agentic/workspace/analysis/brd.md\`
128
+
129
+ When done, tell the user:
130
+
131
+ \`Next type @.agentic/instructions/04-frd.md\`
132
+ `,".agentic/instructions/04-frd.md":`# Step 04: FRD
133
+
134
+ Read:
135
+
136
+ - \`@.agentic/context.md\`
137
+ - \`@.agentic/workspace/analysis/project-overview.md\`
138
+ - \`@.agentic/workspace/analysis/architecture.md\`
139
+ - \`@.agentic/workspace/analysis/brd.md\`
140
+ - any supporting requirement files in \`@.agentic/workspace/requirements/\`
141
+
142
+ Your job:
143
+
144
+ 1. Create a Functional Requirements Document with feature-level detail.
145
+ 2. Cover modules, user flows, functional requirements, validations, edge cases, roles, permissions, reporting needs, and non-functional considerations where relevant.
146
+ 3. Save the markdown draft to \`.agentic/workspace/analysis/frd.md\`.
147
+ 4. Keep the structure ready for handoff to product, design, and engineering teams.
148
+
149
+ Output file:
150
+
151
+ - \`.agentic/workspace/analysis/frd.md\`
152
+
153
+ When done, tell the user:
154
+
155
+ \`Next type @.agentic/instructions/05-estimation.md\`
156
+ `,".agentic/instructions/05-estimation.md":`# Step 05: Estimation
157
+
158
+ Read:
159
+
160
+ - \`@.agentic/context.md\`
161
+ - \`@.agentic/workspace/analysis/project-overview.md\`
162
+ - \`@.agentic/workspace/analysis/architecture.md\`
163
+ - \`@.agentic/workspace/analysis/brd.md\`
164
+ - \`@.agentic/workspace/analysis/frd.md\`
165
+
166
+ Your job:
167
+
168
+ 1. Create a delivery estimation based on the full project context.
169
+ 2. Break effort down by module, role, and phase where possible.
170
+ 3. Include assumptions, dependencies, delivery risks, and scope sensitivity.
171
+ 4. Save the markdown draft to \`.agentic/workspace/analysis/estimation.md\`.
172
+ 5. If the workspace includes generator scripts, mention whether the estimate can be exported into \`.agentic/workspace/documents/\`.
173
+
174
+ Output file:
175
+
176
+ - \`.agentic/workspace/analysis/estimation.md\`
177
+
178
+ When done, tell the user the workflow is complete and list the generated outputs.
179
+ `}),u=[".agentic",".agentic/instructions",".agentic/workspace",".agentic/workspace/requirements",".agentic/workspace/requirements/figma-screenshots",".agentic/workspace/analysis",".agentic/workspace/documents",".agentic/workspace/code",".agentic/workspace/scripts"];async function m(e){await Promise.all(c.map(t=>r(n.join(e,t),{recursive:!0,force:!0})))}async function p(e){await Promise.all(u.map(t=>a(n.join(e,t),{recursive:!0})))}async function l(e){let t=d(e);await Promise.all(Object.entries(t).map(([i,s])=>o(n.join(e,i),s,"utf8")))}async function g(){let e=process.cwd();await m(e),await p(e),await l(e),console.log(""),console.log("create-agentic-starter: scaffold created successfully."),console.log(`Project folder: ${e}`),console.log(""),console.log("Next steps:"),console.log("1. Add screenshots to .agentic/workspace/requirements/figma-screenshots/"),console.log("2. Open your AI tool in this folder."),console.log("3. Start a new chat with @.agentic/init.md"),console.log("")}g().catch(e=>{let t=e instanceof Error?e.message:String(e);console.error(`create-agentic-starter: failed to scaffold project. ${t}`),process.exitCode=1});
package/package.json ADDED
@@ -0,0 +1,36 @@
1
+ {
2
+ "name": "create-agentic-starter",
3
+ "version": "0.1.1",
4
+ "description": "Scaffold a minimal AI-powered project delivery workflow inside the current folder.",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "bin": {
8
+ "create-agentic-starter": "./dist/index.js"
9
+ },
10
+ "files": [
11
+ "dist"
12
+ ],
13
+ "publishConfig": {
14
+ "access": "public"
15
+ },
16
+ "scripts": {
17
+ "build": "tsup",
18
+ "dev": "tsup --watch",
19
+ "prepublishOnly": "npm run typecheck && npm run build",
20
+ "typecheck": "tsc --noEmit"
21
+ },
22
+ "keywords": [
23
+ "ai",
24
+ "agentic",
25
+ "bunx",
26
+ "scaffold"
27
+ ],
28
+ "engines": {
29
+ "node": ">=18"
30
+ },
31
+ "devDependencies": {
32
+ "@types/node": "^22.13.14",
33
+ "tsup": "^8.5.0",
34
+ "typescript": "^5.8.2"
35
+ }
36
+ }