create-agentic-starter 0.1.9 → 0.1.11

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 (22) hide show
  1. package/README.md +71 -26
  2. package/dist/index.js +8 -864
  3. package/dist/templates/commands/architecture.md +28 -0
  4. package/dist/templates/commands/create-brd.md +30 -0
  5. package/dist/templates/commands/create-estimate.md +32 -0
  6. package/dist/templates/commands/create-frd.md +30 -0
  7. package/dist/templates/commands/create-plan.md +38 -0
  8. package/dist/templates/commands/create-proposal.md +29 -0
  9. package/dist/templates/commands/create-tasks.md +35 -0
  10. package/dist/templates/commands/project-requirements.md +34 -0
  11. package/dist/templates/core/context.md +96 -0
  12. package/dist/templates/core/init.md +70 -0
  13. package/dist/templates/meta/agents.md +77 -0
  14. package/dist/templates/scripts/README.md +58 -0
  15. package/dist/templates/scripts/_shared.js +114 -0
  16. package/dist/templates/scripts/generate_brd.js +48 -0
  17. package/dist/templates/scripts/generate_estimate.js +28 -0
  18. package/dist/templates/scripts/generate_frd.js +39 -0
  19. package/dist/templates/scripts/generate_plan.js +62 -0
  20. package/dist/templates/scripts/generate_proposal.js +75 -0
  21. package/dist/templates/scripts/generate_tasks.js +28 -0
  22. package/package.json +2 -2
package/README.md CHANGED
@@ -1,42 +1,59 @@
1
1
  # create-agentic-starter
2
2
 
3
- `create-agentic-starter` scaffolds a lightweight `.agentic/` workspace inside an existing project so AI tools can follow a repeatable kick-off workflow.
3
+ `create-agentic-starter` scaffolds a reusable AI working area inside an existing project.
4
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:
5
+ It is meant for teams who repeatedly do the same early project work:
6
6
 
7
- - requirement gathering
8
- - architecture thinking
9
- - BRD generation
10
- - FRD generation
11
- - estimation
12
- - proposal drafting
7
+ - collect requirements
8
+ - understand screenshots, notes, and references
9
+ - define architecture
10
+ - prepare BRD, FRD, estimate, proposal, plan, and task outputs
13
11
 
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.
12
+ Instead of rebuilding prompts, folders, and working conventions for every new project, this package gives the team a standard `.agentic/` setup that works across AI tools such as Codex, Claude, Cursor, Zed, and similar agentic workflows.
15
13
 
16
- ## Usage
14
+ ## What This Project Is Trying To Achieve
15
+
16
+ The package creates a lightweight but structured workflow inside the target project so an AI agent can:
17
+
18
+ - understand the project from the files already present
19
+ - gather missing context from the user
20
+ - keep project memory in one place
21
+ - generate internal drafts
22
+ - create user-facing deliverables under `.docs/`
23
+ - use starter export scripts for `.docx`, `.xlsx`, and `.pptx` outputs
24
+
25
+ The goal is not to generate code for the product itself on day one. The goal is to standardize the project kick-off and delivery-document workflow so any team member can start from the same foundation.
26
+
27
+ ## How To Run It
28
+
29
+ Run the command inside an existing project folder.
17
30
 
18
31
  ```bash
19
32
  npx create-agentic-starter
20
33
  ```
21
34
 
35
+ or
36
+
22
37
  ```bash
23
38
  bunx create-agentic-starter
24
39
  ```
25
40
 
26
- Run the command inside an existing project folder.
41
+ The command is non-interactive. It does not ask setup questions.
27
42
 
28
- The scaffold is non-interactive. It will:
43
+ ## What The Command Does
44
+
45
+ When you run it, it will:
29
46
 
30
47
  - recreate `.agentic/`
31
48
  - create `.docs/` for user-facing outputs
32
- - preserve existing `AGENTS.md`, appending a marked `create-agentic-starter` section when needed
49
+ - preserve an existing `AGENTS.md` and append a marked `create-agentic-starter` section when needed
33
50
  - never modify `.gitignore`
34
51
  - never modify `README.md`
35
- - print the next step for the team
52
+ - print the next step for the team: start with `@.agentic/init.md`
36
53
 
37
- ## Generated Structure
54
+ ## What Gets Created
38
55
 
39
- The command sets up:
56
+ The scaffold sets up:
40
57
 
41
58
  - `.agentic/init.md`
42
59
  - `.agentic/context.md`
@@ -48,18 +65,46 @@ The command sets up:
48
65
  - `.docs/`
49
66
  - `AGENTS.md`
50
67
 
51
- The scaffold also includes starter export scripts under `.agentic/workspace/scripts/` for:
68
+ This gives you a clear split:
52
69
 
53
- - `.docx` via `docx`
54
- - `.pptx` via `pptxgenjs`
55
- - `.xlsx` via `exceljs`
70
+ - `.agentic/workspace/project/` for raw project materials
71
+ - `.agentic/workspace/memory/` for AI-maintained project understanding
72
+ - `.agentic/workspace/documents/` for internal drafts and structured export input
73
+ - `.agentic/workspace/scripts/` for starter export scripts
74
+ - `.docs/` for final user-facing outputs
56
75
 
57
- Those scripts are meant to be adapted per project when the user provides a specific template or output style.
76
+ ## Export Scripts
58
77
 
59
- ## First Run Flow
78
+ The scaffold includes starter export scripts under `.agentic/workspace/scripts/` for:
60
79
 
61
- After scaffolding:
80
+ - `.docx` via `docx`
81
+ - `.pptx` via `pptxgenjs`
82
+ - `.xlsx` via `exceljs`
62
83
 
63
- 1. Open your AI tool in the project.
64
- 2. Start a new session with `@.agentic/init.md`.
65
- 3. Follow the command sequence defined in `AGENTS.md`.
84
+ These scripts are intentionally starter implementations. They are expected to be adapted by the AI agent when the user provides:
85
+
86
+ - a custom template
87
+ - a preferred document style
88
+ - a specific export structure
89
+
90
+ ## Typical Workflow
91
+
92
+ 1. Run `npx create-agentic-starter` or `bunx create-agentic-starter` in the target project.
93
+ 2. Open that project in your AI tool.
94
+ 3. Start a new session with `@.agentic/init.md`.
95
+ 4. Let the agent understand the project, ask questions, and update memory files.
96
+ 5. Continue with commands in `.agentic/commands/` such as:
97
+ - `@.agentic/commands/project-requirements.md`
98
+ - `@.agentic/commands/architecture.md`
99
+ - `@.agentic/commands/create-brd.md`
100
+ - `@.agentic/commands/create-frd.md`
101
+ - `@.agentic/commands/create-estimate.md`
102
+ - `@.agentic/commands/create-proposal.md`
103
+ - `@.agentic/commands/create-plan.md`
104
+ - `@.agentic/commands/create-tasks.md`
105
+
106
+ ## Notes
107
+
108
+ - The scaffold is designed to be lightweight and easy to drop into an existing repo.
109
+ - It is prompt-driven first, with export scripts available when the workflow needs generated Office documents.
110
+ - `AGENTS.md` is used as the human-readable guide inside the target project.