@akm1923main/init-project 1.0.0 โ†’ 1.2.0

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 (39) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +348 -27
  3. package/index.js +27 -22
  4. package/package.json +16 -4
  5. package/templates/02_Skills/agents/Architect.md +149 -289
  6. package/templates/02_Skills/agents/Business_Analyst.md +97 -103
  7. package/templates/02_Skills/agents/Deployment_Engineer.md +125 -222
  8. package/templates/02_Skills/agents/DevOps_Engineer.md +119 -219
  9. package/templates/02_Skills/agents/Documentation_Writer.md +172 -237
  10. package/templates/02_Skills/agents/Helper_Agent.md +258 -0
  11. package/templates/02_Skills/agents/Idea_Analyst.md +99 -108
  12. package/templates/02_Skills/agents/Master_Orchestrator.md +243 -108
  13. package/templates/02_Skills/agents/Performance_Engineer.md +122 -162
  14. package/templates/02_Skills/agents/Product_Manager.md +101 -137
  15. package/templates/02_Skills/agents/Refactor_Specialist.md +307 -6
  16. package/templates/02_Skills/agents/Security_Engineer.md +178 -253
  17. package/templates/02_Skills/agents/Staff_Engineer.md +200 -204
  18. package/templates/02_Skills/agents/Testing_Engineer.md +155 -206
  19. package/templates/02_Skills/workflows/architecture_generation_workflow.md +92 -25
  20. package/templates/02_Skills/workflows/business_analysis_workflow.md +69 -25
  21. package/templates/02_Skills/workflows/deployment_workflow.md +97 -12
  22. package/templates/02_Skills/workflows/devops_setup_workflow.md +97 -10
  23. package/templates/02_Skills/workflows/documentation_workflow.md +84 -280
  24. package/templates/02_Skills/workflows/idea_refinement_workflow.md +77 -52
  25. package/templates/02_Skills/workflows/performance_review_workflow.md +98 -10
  26. package/templates/02_Skills/workflows/prd_generation_workflow.md +85 -34
  27. package/templates/02_Skills/workflows/refactor_workflow.md +106 -13
  28. package/templates/02_Skills/workflows/security_audit_workflow.md +94 -12
  29. package/templates/02_Skills/workflows/task_execution_workflow.md +129 -15
  30. package/templates/02_Skills/workflows/task_generation_workflow.md +99 -25
  31. package/templates/02_Skills/workflows/testing_workflow.md +92 -12
  32. package/templates/02_Skills/workflows/workflow_governance_rules.md +239 -63
  33. package/templates/PROJECT_README.md +277 -0
  34. package/QUICKSTART_CREATE_AI_PROJECT.md +0 -52
  35. package/templates/02_Skills/Legacy_Prompts/Architecture.md +0 -72
  36. package/templates/02_Skills/Legacy_Prompts/Coding_Discipline.md +0 -283
  37. package/templates/02_Skills/Legacy_Prompts/Generate_prd.md +0 -129
  38. package/templates/02_Skills/Legacy_Prompts/IDEA.md +0 -188
  39. package/templates/02_Skills/Legacy_Prompts/Sharder.md +0 -359
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Amit Kumar Bind (Akm1923)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,48 +1,369 @@
1
- # create-ai-project
1
+ # ๐Ÿš€ AI-OS Project Initializer
2
2
 
3
- A CLI that scaffolds an **AI-OS** project structure.
3
+ [![npm version](https://img.shields.io/npm/v/@akm1923main/init-project.svg)](https://www.npmjs.com/package/@akm1923main/init-project)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
5
 
5
- ## Key guarantee (your requirement)
6
+ > **Scaffold production-grade, AI-driven projects in seconds.**
7
+ > An 11-phase development pipeline with **14 specialist agents**, **14 structured workflows**, and a full state-tracking system โ€” ready to go with one command.
6
8
 
7
- When you initialize a project, the generated project will contain **02_Skills/** with the **exact same files and content** that ship inside this CLI package.
9
+ ---
8
10
 
9
- - No external copy paths
10
- - No tiny placeholders
11
- - The standard skills are bundled under: `templates/02_Skills/`
11
+ ## ๐Ÿค” Why AI-OS?
12
12
 
13
- > Note: By your preference, generated projects include `02_Skills/` in `.gitignore`.
13
+ Building software with AI agents is powerful โ€” but without structure, it becomes chaos. AI-OS gives you a **deterministic, phase-based pipeline** where every agent knows exactly what to do, what it needs, and what it produces.
14
14
 
15
- ## Usage (local dev)
15
+ | Without AI-OS | With AI-OS |
16
+ | :------------------------------------- | :------------------------------------------------------- |
17
+ | โŒ Hours of boilerplate setup | โœ…**One command, full structure** |
18
+ | โŒ Agents running without coordination | โœ…**11-phase pipeline with strict ordering** |
19
+ | โŒ No state tracking between sessions | โœ…**Evolution ledger + resume logic** |
20
+ | โŒ Inconsistent project structures | โœ…**Enterprise-grade, standardized architecture** |
21
+ | โŒ Lost context when switching agents | โœ…**Inter-agent contracts with explicit handoffs** |
22
+ | โŒ No idea what to do next | โœ…**๐Ÿงญ Helper Agent tells you exactly** |
23
+
24
+ ---
25
+
26
+ ## โšก Quick Start
27
+
28
+ No installation needed. Run directly with `npx`:
29
+
30
+ ```bash
31
+ npx @akm1923main/init-project my-project
32
+ ```
33
+
34
+ **That's it.** Open the generated folder and start with `PROJECT_STATE.md`.
35
+
36
+ ### Options
37
+
38
+ ```bash
39
+ npx @akm1923main/init-project <project-name> [options]
40
+
41
+ Options:
42
+ --path, -p <dir> Target directory (default: current directory)
43
+ --force, -f Allow existing folder (adds missing items only)
44
+ --help, -h Show help
45
+ ```
46
+
47
+ ### Examples
16
48
 
17
49
  ```bash
18
- cd "C:\Users\hp\Desktop\New folder\create-ai-project"
19
- npm link
20
- create-ai-project my-project
50
+ # Create in current directory
51
+ npx @akm1923main/init-project my-saas-app
52
+
53
+ # Create in a specific folder
54
+ npx @akm1923main/init-project my-saas-app --path ~/projects
55
+
56
+ # Add missing files to an existing project
57
+ npx @akm1923main/init-project my-saas-app --force
58
+ ```
59
+
60
+ ---
61
+
62
+ ## ๐Ÿ”„ The AI-OS Pipeline
63
+
64
+ Every project follows an **11-phase sequential pipeline**. Each phase is owned by a specialist agent that reads upstream artifacts and produces its own output.
65
+
66
+ ```mermaid
67
+ flowchart TD
68
+ START(["Project Created"]) --> P01
69
+
70
+ subgraph PLAN ["Planning Phases"]
71
+ P01["Phase 01: Idea Refinement\nAgent: Idea_Analyst\nOutput: IDEA.md"]
72
+ P02["Phase 02: Business Analysis\nAgent: Business_Analyst\nOutput: PRODUCT_ANALYSIS.md"]
73
+ P03["Phase 03: PRD Generation\nAgent: Product_Manager\nOutput: PRD.md"]
74
+ P04["Phase 04: Architecture\nAgent: Architect\nOutput: ARCHITECTURE.md"]
75
+ end
76
+
77
+ subgraph BUILD ["Build Phases"]
78
+ P05["Phase 05: Task Generation\nAgent: Staff_Engineer A\nOutput: TASK_PLAN.md"]
79
+ P06["Phase 06: Task Execution\nAgent: Staff_Engineer B\nOutput: Code in 05_Project"]
80
+ end
81
+
82
+ subgraph QUALITY ["Quality Phases"]
83
+ P07["Phase 07: Testing\nAgent: Testing_Engineer\nOutput: TEST_REPORT.md"]
84
+ P08["Phase 08: Security Audit\nAgent: Security_Engineer\nOutput: SECURITY_AUDIT.md"]
85
+ P09["Phase 09: Performance\nAgent: Performance_Engineer\nOutput: PERFORMANCE_REPORT.md"]
86
+ end
87
+
88
+ subgraph SHIP ["Ship Phases"]
89
+ P10["Phase 10: DevOps\nAgent: DevOps_Engineer\nOutput: DEVOPS_PLAN.md"]
90
+ P11["Phase 11: Deployment\nAgent: Deployment_Engineer\nOutput: DEPLOYMENT_GUIDE.md"]
91
+ end
92
+
93
+ P01 --> P02 --> P03 --> P04
94
+ P04 --> P05 --> P06
95
+ P06 --> P07 --> P08 --> P09
96
+ P09 --> P10 --> P11
97
+ P11 --> DONE(["Shipped!"])
98
+
99
+ HELPER["Helper Agent\nActivate anytime"]
100
+ DOCS["Documentation Writer\nCross-cutting"]
101
+ REFACTOR["Refactor Specialist\nCross-cutting"]
102
+ ORCHESTRATOR["Master Orchestrator\nCoordinates all agents"]
103
+
104
+ style PLAN fill:#e3f2fd,stroke:#1565c0,color:#000
105
+ style BUILD fill:#fff3e0,stroke:#e65100,color:#000
106
+ style QUALITY fill:#e8f5e9,stroke:#2e7d32,color:#000
107
+ style SHIP fill:#fce4ec,stroke:#c62828,color:#000
108
+ style HELPER fill:#2d6a4f,stroke:#40916c,color:#fff
109
+ style DOCS fill:#1d3557,stroke:#457b9d,color:#fff
110
+ style REFACTOR fill:#6a040f,stroke:#9d0208,color:#fff
111
+ style ORCHESTRATOR fill:#7b2cbf,stroke:#9d4edd,color:#fff
112
+ style START fill:#f4a261,stroke:#e76f51,color:#000
113
+ style DONE fill:#2a9d8f,stroke:#264653,color:#fff
114
+ ```
115
+
116
+ ---
117
+
118
+ ## ๐Ÿค– Agents (14)
119
+
120
+ Every agent has a **defined identity**, **inter-agent communication contracts**, **lifecycle integration**, and **quality checklists**.
121
+
122
+ ### ๐Ÿ“ Pipeline Agents (11)
123
+
124
+ These agents own specific phases and execute in sequence:
125
+
126
+ | Phase | Agent | Role | Produces |
127
+ | :---- | :---------------------------------------- | :--------------------------------------------------- | :---------------------------- |
128
+ | 01 | ๐Ÿ’ก**Idea_Analyst** | Refines raw ideas into structured concepts | `IDEA.md` |
129
+ | 02 | ๐Ÿ“Š**Business_Analyst** | Evaluates commercial viability and market fit | `PRODUCT_ANALYSIS.md` |
130
+ | 03 | ๐Ÿ“Œ**Product_Manager** | Generates detailed PRD with functional requirements | `PRD.md` |
131
+ | 04 | ๐Ÿ—๏ธ**Architect** | Designs system architecture, tech stack, data models | `ARCHITECTURE.md` |
132
+ | 05 | ๐Ÿ“‹**Staff_Engineer** *(Mode A)* | Decomposes architecture into atomic tasks | `TASK_PLAN.md` + task files |
133
+ | 06 | โš™๏ธ**Staff_Engineer** *(Mode B)* | Implements each task against architecture | Code in `05_Project/` |
134
+ | 07 | ๐Ÿงช**Testing_Engineer** | Validates code against PRD requirements | `TEST_REPORT.md` |
135
+ | 08 | ๐Ÿ”**Security_Engineer** | STRIDE threat modeling + OWASP compliance audit | `SECURITY_AUDIT.md` |
136
+ | 09 | โšก**Performance_Engineer** | Identifies bottlenecks, evaluates scalability | `PERFORMANCE_REPORT.md` |
137
+ | 10 | ๐Ÿ› ๏ธ**DevOps_Engineer** | Designs CI/CD, infrastructure, containerization | `DEVOPS_PLAN.md` |
138
+ | 11 | ๐ŸŒ**Deployment_Engineer** | Platform-specific deployment + runbooks | `DEPLOYMENT_GUIDE.md` |
139
+
140
+ ### ๐Ÿ”€ Cross-Cutting Agents (3)
141
+
142
+ These agents can be activated at **any phase**:
143
+
144
+ | Agent | Role | When to Use |
145
+ | :------------------------------- | :---------------------------------------------------- | :---------------------------------------- |
146
+ | ๐ŸŽฏ**Master_Orchestrator** | Coordinates multi-agent workflows, resolves conflicts | Complex multi-phase operations |
147
+ | ๐Ÿ“˜**Documentation_Writer** | Generates system documentation from project artifacts | Any phase that needs docs |
148
+ | ๐Ÿ”**Refactor_Specialist** | Code quality improvements, architectural cleanup | During or after implementation |
149
+ | ๐Ÿงญ**Helper_Agent** | Reads project state and tells you what to do next | **Anytime you're lost or confused** |
150
+
151
+ > **๐Ÿ’ก New to AI-OS?** Start with the **๐Ÿงญ Helper Agent** โ€” it reads your project state and tells you exactly which agent to activate and what to do next.
152
+
153
+ ---
154
+
155
+ ## ๐Ÿ“‹ Workflows (14)
156
+
157
+ Each workflow defines a **6-stage lifecycle**: Initialize โ†’ Validate โ†’ Execute โ†’ Verify โ†’ Close โ†’ State Sync.
158
+
159
+ ### Pipeline Workflows
160
+
161
+ | # | Workflow | Bound Agent | Phase |
162
+ | :---- | :------------------------------------------ | :------------------- | :---- |
163
+ | WF-01 | ๐Ÿ’ก`idea_refinement_workflow.md` | Idea_Analyst | 01 |
164
+ | WF-02 | ๐Ÿ“Š`business_analysis_workflow.md` | Business_Analyst | 02 |
165
+ | WF-03 | ๐Ÿ“Œ`prd_generation_workflow.md` | Product_Manager | 03 |
166
+ | WF-04 | ๐Ÿ—๏ธ`architecture_generation_workflow.md` | Architect | 04 |
167
+ | WF-05 | ๐Ÿ“‹`task_generation_workflow.md` | Staff_Engineer (A) | 05 |
168
+ | WF-06 | โš™๏ธ`task_execution_workflow.md` | Staff_Engineer (B) | 06 |
169
+ | WF-07 | ๐Ÿงช`testing_workflow.md` | Testing_Engineer | 07 |
170
+ | WF-08 | ๐Ÿ”`security_audit_workflow.md` | Security_Engineer | 08 |
171
+ | WF-09 | โšก`performance_review_workflow.md` | Performance_Engineer | 09 |
172
+ | WF-10 | ๐Ÿ› ๏ธ`devops_setup_workflow.md` | DevOps_Engineer | 10 |
173
+ | WF-11 | ๐ŸŒ`deployment_workflow.md` | Deployment_Engineer | 11 |
174
+
175
+ ### Cross-Cutting Workflows
176
+
177
+ | Workflow | Purpose |
178
+ | :----------------------------------- | :----------------------------------------------------------- |
179
+ | ๐Ÿ“˜`documentation_workflow.md` | System documentation generation |
180
+ | ๐Ÿ”`refactor_workflow.md` | Code quality improvement cycles |
181
+ | ๐Ÿ›๏ธ`workflow_governance_rules.md` | Supreme governance: arbitration, drift detection, escalation |
182
+
183
+ ---
184
+
185
+ ## ๐Ÿ“‚ Generated Project Structure
186
+
187
+ ```
188
+ my-project/
189
+ โ”œโ”€โ”€ ๐Ÿ“Š PROJECT_STATE.md โ† Your project's single source of truth
190
+ โ”œโ”€โ”€ ๐Ÿท๏ธ VERSION.md โ† Version + framework metadata
191
+ โ”œโ”€โ”€ ๐Ÿ“„ README.md โ† Project-level getting started guide
192
+ โ”œโ”€โ”€ ๐Ÿ”’ .gitignore
193
+ โ”œโ”€โ”€ ๐Ÿ”‘ .env.example
194
+ โ”‚
195
+ โ”œโ”€โ”€ ๐Ÿ“š 01_Knowledge/ โ† Reference docs, domain knowledge
196
+ โ”‚
197
+ โ”œโ”€โ”€ ๐Ÿค– 02_Skills/ โ† Agent + workflow definitions (git-ignored)
198
+ โ”‚ โ”œโ”€โ”€ agents/ โ† 14 agent persona files
199
+ โ”‚ โ””โ”€โ”€ workflows/ โ† 14 workflow files
200
+ โ”‚
201
+ โ”œโ”€โ”€ ๐Ÿ“„ 03_Project_Info/ โ† Agent output artifacts
202
+ โ”‚ โ”œโ”€โ”€ Idea_Analyst/ โ† IDEA.md goes here
203
+ โ”‚ โ”œโ”€โ”€ Business_Analyst/ โ† PRODUCT_ANALYSIS.md goes here
204
+ โ”‚ โ”œโ”€โ”€ Product_Manager/ โ† PRD.md goes here
205
+ โ”‚ โ”œโ”€โ”€ Architect/ โ† ARCHITECTURE.md goes here
206
+ โ”‚ โ”œโ”€โ”€ Testing_Engineer/ โ† TEST_REPORT.md goes here
207
+ โ”‚ โ”œโ”€โ”€ Security_Engineer/ โ† SECURITY_AUDIT.md goes here
208
+ โ”‚ โ”œโ”€โ”€ Performance_Engineer/ โ† PERFORMANCE_REPORT.md goes here
209
+ โ”‚ โ””โ”€โ”€ DevOps_Engineer/ โ† DEVOPS_PLAN.md goes here
210
+ โ”‚
211
+ โ”œโ”€โ”€ ๐Ÿ“‹ 04_Tasks/ โ† Task management
212
+ โ”‚ โ”œโ”€โ”€ TASK_PLAN.md โ† Master task list
213
+ โ”‚ โ”œโ”€โ”€ DEVELOPMENT_CHECKLIST.md โ† Execution tracker
214
+ โ”‚ โ”œโ”€โ”€ PROGRESS_LOG.md โ† Chronological completion log
215
+ โ”‚ โ”œโ”€โ”€ RISK_REGISTER.md โ† Risk tracking
216
+ โ”‚ โ”œโ”€โ”€ TASKS/ โ† Individual task files
217
+ โ”‚ โ”‚ โ””โ”€โ”€ TEMPLATE_TASK.md โ† Task template
218
+ โ”‚ โ””โ”€โ”€ ARCHIVE/ โ† Completed task archive
219
+ โ”‚
220
+ โ”œโ”€โ”€ ๐Ÿ’ป 05_Project/ โ† Your actual implementation code
221
+ โ”‚ โ””โ”€โ”€ README.md
222
+ โ”‚
223
+ โ”œโ”€โ”€ ๐Ÿ“˜ 06_Documentation/ โ† Generated system docs
224
+ โ”‚
225
+ โ””โ”€โ”€ ๐Ÿงญ 07_state/ โ† State tracking & decisions
226
+ โ”œโ”€โ”€ CHANGELOG.md โ† Version-by-version changes
227
+ โ”œโ”€โ”€ DECISIONS.md โ† Every significant decision
228
+ โ”œโ”€โ”€ ADR.md โ† Architecture Decision Records
229
+ โ”œโ”€โ”€ KNOWN_ISSUES.md โ† Issue tracker
230
+ โ””โ”€โ”€ INCIDENT_LOG.md โ† Production incident log
21
231
  ```
22
232
 
23
- ## Usage (npx โ€” the way you want)
233
+ ---
24
234
 
25
- After you publish this package to npm:
235
+ ## ๐ŸŽฏ How to Use (Step by Step)
236
+
237
+ ### 1. Create Your Project
26
238
 
27
239
  ```bash
28
- npx create-ai-project my-project
240
+ npx @akm1923main/init-project my-project
241
+ cd my-project
29
242
  ```
30
243
 
31
- ## Options
244
+ ### 2. Check Your Starting Point
245
+
246
+ Open `PROJECT_STATE.md` โ€” it shows you're at **Phase 01** with **Idea_Analyst** as the current agent.
247
+
248
+ ### 3. Activate the Current Agent
249
+
250
+ Tell your AI assistant to act as the **Idea_Analyst** agent. Point it to:
251
+
252
+ - `02_Skills/agents/Idea_Analyst.md` โ€” agent identity and rules
253
+ - `02_Skills/workflows/idea_refinement_workflow.md` โ€” the workflow to follow
254
+
255
+ ### 4. Work Through the Pipeline
256
+
257
+ Each agent:
258
+
259
+ 1. Reads its upstream artifacts
260
+ 2. Follows its bound workflow (6 stages)
261
+ 3. Produces its output artifact
262
+ 4. Updates `PROJECT_STATE.md` and `PROGRESS_LOG.md`
263
+ 5. Hands off to the next agent
264
+
265
+ ### 5. Lost? Use the Helper Agent
266
+
267
+ At **any point**, activate the **๐Ÿงญ Helper Agent** (`02_Skills/agents/Helper_Agent.md`). It will:
268
+
269
+ - Read all your project state files
270
+ - Tell you exactly where you are
271
+ - Tell you what to do next
272
+ - Flag any drift or skipped phases
273
+
274
+ ---
275
+
276
+ ## ๐Ÿ“Š State Tracking System
277
+
278
+ AI-OS tracks everything automatically:
279
+
280
+ | File | What It Tracks |
281
+ | :------------------------------------ | :------------------------------------------------------------ |
282
+ | `PROJECT_STATE.md` | ๐Ÿ“Š Current phase, agent, pipeline status, resume instructions |
283
+ | `04_Tasks/PROGRESS_LOG.md` | ๐Ÿ“œ Chronological record of every phase completion |
284
+ | `04_Tasks/TASK_PLAN.md` | ๐Ÿ“‹ All tasks with priority, complexity, dependencies |
285
+ | `04_Tasks/DEVELOPMENT_CHECKLIST.md` | โœ… Per-task completion tracker |
286
+ | `04_Tasks/RISK_REGISTER.md` | โš ๏ธ Project risks with severity classification |
287
+ | `07_state/CHANGELOG.md` | ๐Ÿ“œ Version-by-version change history |
288
+ | `07_state/DECISIONS.md` | ๐Ÿงญ Every decision with phase/agent attribution |
289
+ | `07_state/ADR.md` | ๐Ÿ›๏ธ Immutable architecture decision records |
290
+ | `07_state/KNOWN_ISSUES.md` | ๐Ÿ› Issue tracker with severity levels |
291
+ | `07_state/INCIDENT_LOG.md` | ๐Ÿšจ Production incident log with response protocol |
292
+
293
+ ---
294
+
295
+ ## ๐Ÿ—๏ธ Architecture Principles
296
+
297
+ | Principle | Implementation |
298
+ | :----------------------------- | :---------------------------------------------------- |
299
+ | **Phase-Based Pipeline** | 11 sequential phases with strict ordering |
300
+ | **Agent Ownership** | Each phase owned by exactly one specialist agent |
301
+ | **Artifact Contracts** | Explicit input/output schemas between agents |
302
+ | **State Persistence** | Evolution ledger tracks all progress across sessions |
303
+ | **Resume Safety** | Any agent can resume from the last recorded state |
304
+ | **Drift Detection** | Governance rules detect and flag inconsistencies |
305
+ | **Self-Validating** | Each workflow verifies its own outputs before closing |
306
+
307
+ ---
308
+
309
+ ## โš™๏ธ How It Works Internally
310
+
311
+ ```mermaid
312
+ flowchart LR
313
+ A["npx init-project my-app"] --> B["Download from npm"]
314
+ B --> C["Run index.js"]
315
+ C --> D["Parse CLI args"]
316
+ D --> E["Create folder structure"]
317
+ E --> F["Copy 02_Skills\nagents + workflows"]
318
+ F --> G["Generate state files\nPROJECT_STATE, VERSION, etc."]
319
+ G --> H["Project ready!"]
320
+
321
+ style A fill:#f4a261,stroke:#e76f51,color:#000
322
+ style H fill:#2a9d8f,stroke:#264653,color:#fff
323
+ ```
324
+
325
+ 1. **`npx`** downloads the latest version from npm
326
+ 2. **`index.js`** parses arguments and creates the folder skeleton
327
+ 3. **Bundled templates** (`templates/02_Skills/`) are copied as-is โ€” 14 agents, 14 workflows
328
+ 4. **Inline templates** generate all state tracking files with initial content
329
+ 5. **Zero dependencies** โ€” pure Node.js, no npm packages required
330
+
331
+ ---
332
+
333
+ ## ๐Ÿ Default: Python + uv
334
+
335
+ The generated project defaults to Python with [uv](https://github.com/astral-sh/uv) for package management:
32
336
 
33
337
  ```bash
34
- create-ai-project <project-name> [--path <targetDir>] [--force]
338
+ cd 05_Project
339
+ uv venv
340
+ uv pip install <package>
35
341
  ```
36
342
 
37
- ## What gets created at init
38
- - Folder skeleton (AI-OS)
39
- - `PROJECT_STATE.md`, `.gitignore`, `.env.example`, `VERSION.md`
40
- - `04_Tasks/*` and `07_state/*`
41
- - **02_Skills/** copied from bundled templates
343
+ > You can use any language or framework โ€” just put your code in `05_Project/`.
344
+
345
+ ---
346
+
347
+ ## ๐Ÿค Contributing
348
+
349
+ Contributions are welcome! If you have ideas for:
350
+
351
+ - ๐Ÿค– New agent personas
352
+ - ๐Ÿ“‹ New workflows
353
+ - ๐Ÿ”ง Improvements to templates or scaffolding
354
+
355
+ Please open an issue or submit a pull request on our [GitHub repository](https://github.com/Akm1923/init-project).
356
+
357
+ ---
358
+
359
+ ## ๐Ÿ“„ License
360
+
361
+ MIT ยฉ [Amit Kumar Bind](https://github.com/Akm1923)
362
+
363
+ ---
364
+
365
+ ---
42
366
 
43
- ### Empty docs behavior (by design)
44
- Initializer creates folders but does NOT create empty markdown files under:
45
- - `03_Project_Info/*` (folders only)
46
- - `06_Documentation/*` (folder only)
367
+ **Built with โค๏ธ for AI-driven development**
47
368
 
48
- Agents/workflows generate/update those later.
369
+ *AI-OS 14 agents ยท 14 workflows ยท 11 phases ยท Zero dependencies*
package/index.js CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env node
2
+ // ยฉ 2026 Amit Kumar Bind (Akm1923). MIT License.
3
+ // https://github.com/Akm1923/init-project
2
4
 
3
5
  /**
4
6
  * create-ai-project
@@ -94,11 +96,11 @@ function main() {
94
96
  console.log(
95
97
  normalizeLines(
96
98
  `create-ai-project - AI-OS project initializer\n\n` +
97
- `Usage:\n create-ai-project <project-name> [--path <targetDir>] [--force]\n\n` +
98
- `Options:\n` +
99
- ` --path, -p Target directory (default: current directory)\n` +
100
- ` --force, -f Allow existing folder (will only add missing items)\n` +
101
- ` --help, -h Show help\n`
99
+ `Usage:\n create-ai-project <project-name> [--path <targetDir>] [--force]\n\n` +
100
+ `Options:\n` +
101
+ ` --path, -p Target directory (default: current directory)\n` +
102
+ ` --force, -f Allow existing folder (will only add missing items)\n` +
103
+ ` --help, -h Show help\n`
102
104
  )
103
105
  );
104
106
  process.exit(args.help ? 0 : 1);
@@ -144,11 +146,11 @@ function main() {
144
146
  const now = new Date().toISOString();
145
147
 
146
148
  // Root files
147
- writeFileIfNotExists(path.join(projectPath, 'VERSION.md'), `# VERSION\n\n0.1.0\n`);
149
+ writeFileIfNotExists(path.join(projectPath, 'VERSION.md'), `# ๐Ÿท๏ธ VERSION\n\n> Track your project version and the AI-OS framework powering it.\n\n---\n\n## ๐Ÿ“ฆ Current Version\n\n**v0.1.0**\n\n---\n\n## ๐Ÿค– Framework Details\n\n| Field | Value |\n|:------|:------|\n| Framework | AI-OS |\n| Version | 1.2.0 |\n| Pipeline Phases | 11 Sequential |\n| Active Agents | 14 |\n| Workflow Definitions | 14 |\n\n---\n\n## ๐Ÿ“œ Version History\n\n| Version | Date | Description |\n|:--------|:-----|:------------|\n| v0.1.0 | ${now} | ๐ŸŽ‰ Initial project scaffold |\n\n---\n\n*Updated automatically by AI-OS agents during phase transitions.*\n`);
148
150
 
149
151
  writeFileIfNotExists(
150
152
  path.join(projectPath, 'PROJECT_STATE.md'),
151
- `# PROJECT_STATE\n\nCreated: ${now}\n\n## Purpose\n- \n\n## Current status\n- Phase: discovery / build / test / ship\n\n## Top priorities\n- [ ]\n\n## Key decisions\n- See: 07_state/DECISIONS.md\n- See: 07_state/ADR.md\n`
153
+ `# ๐Ÿ“Š PROJECT STATE โ€” Evolution Ledger\n\n> **This is your project's single source of truth.** Every agent reads this file first to know where the project stands.\n\n---\n\n## ๐Ÿ†” Project Identity\n\n| Field | Value |\n|:------|:------|\n| **Project Name** | ${projectName} |\n| **Created** | ${now} |\n| **Framework** | AI-OS v1.2.0 |\n| **Current Phase** | 01 โ€” Idea Refinement |\n| **Current Agent** | Idea_Analyst |\n| **Pipeline Status** | โณ Not Started |\n\n---\n\n## ๐Ÿ”„ Phase Tracker\n\n> Each row represents one pipeline phase. Agents update this table as they complete their work.\n\n| # | Phase | Agent | Status | Output Artifact | Completed |\n|:--|:------|:------|:-------|:----------------|:----------|\n| 01 | ๐Ÿ’ก Idea Refinement | Idea_Analyst | โณ Not Started | IDEA.md | โ€” |\n| 02 | ๐Ÿ“Š Business Analysis | Business_Analyst | โณ Not Started | PRODUCT_ANALYSIS.md | โ€” |\n| 03 | ๐Ÿ“Œ PRD Generation | Product_Manager | โณ Not Started | PRD.md | โ€” |\n| 04 | ๐Ÿ—๏ธ Architecture | Architect | โณ Not Started | ARCHITECTURE.md | โ€” |\n| 05 | ๐Ÿ“‹ Task Generation | Staff_Engineer (A) | โณ Not Started | TASK_PLAN.md | โ€” |\n| 06 | โš™๏ธ Task Execution | Staff_Engineer (B) | โณ Not Started | Code in 05_Project/ | โ€” |\n| 07 | ๐Ÿงช Testing | Testing_Engineer | โณ Not Started | TEST_REPORT.md | โ€” |\n| 08 | ๐Ÿ” Security Audit | Security_Engineer | โณ Not Started | SECURITY_AUDIT.md | โ€” |\n| 09 | โšก Performance | Performance_Engineer | โณ Not Started | PERFORMANCE_REPORT.md | โ€” |\n| 10 | ๐Ÿš€ DevOps | DevOps_Engineer | โณ Not Started | DEVOPS_PLAN.md | โ€” |\n| 11 | ๐ŸŒ Deployment | Deployment_Engineer | โณ Not Started | DEPLOYMENT_GUIDE.md | โ€” |\n\n---\n\n## ๐Ÿšง Blocking Issues\n\n> *None at this time.*\n\n---\n\n## ๐Ÿ“Ž Key References\n\n- ๐Ÿ“ Decisions โ†’ \`07_state/DECISIONS.md\`\n- ๐Ÿ›๏ธ Architecture Decisions โ†’ \`07_state/ADR.md\`\n- ๐Ÿ“œ Change History โ†’ \`07_state/CHANGELOG.md\`\n\n---\n\n## ๐Ÿ” How to Resume\n\n> If the project was paused or context was lost, follow these steps:\n\n1. Read **this file** to identify the current phase and agent\n2. Read the last entry in \`04_Tasks/PROGRESS_LOG.md\` for context\n3. Activate the agent listed under **Current Agent**\n4. The agent will read its required upstream artifacts and continue\n\n---\n\n*Last updated: ${now}*\n`
152
154
  );
153
155
 
154
156
  // You explicitly want skills ignored in generated projects.
@@ -165,33 +167,33 @@ function main() {
165
167
  // Tasks + state (these are useful even if empty)
166
168
  writeFileIfNotExists(
167
169
  path.join(projectPath, '04_Tasks', 'TASK_PLAN.md'),
168
- `# TASK_PLAN\n\n## Milestones\n\n## Tasks\n- [ ]\n\nCreated: ${now}\n`
170
+ `# ๐Ÿ“‹ TASK PLAN\n\n> **Master task list for implementation.** Generated by Staff_Engineer (Mode A) during Phase 05.\n> Each task maps to an architecture component and traces back to a PRD requirement.\n\n---\n\n## ๐Ÿ“Š Generation Status\n\n| Field | Value |\n|:------|:------|\n| Generated By | Staff_Engineer (Mode A) |\n| Architecture Source | \`03_Project_Info/Architect/ARCHITECTURE.md\` |\n| PRD Source | \`03_Project_Info/Product_Manager/PRD.md\` |\n| Total Tasks | 0 |\n| Critical Path Tasks | 0 |\n| Status | โณ Not Generated |\n| Created | ${now} |\n\n---\n\n## ๐Ÿ“ฆ Task Summary\n\n> Tasks are populated automatically during Phase 05 โ€” Task Generation.\n\n| Task ID | Title | Priority | Complexity | Dependencies | Status |\n|:--------|:------|:---------|:-----------|:-------------|:-------|\n| โ€” | *Awaiting generation* | โ€” | โ€” | โ€” | โณ |\n\n---\n\n## ๐Ÿ”ฅ Critical Path\n\n> *Not yet identified. Will be marked during Task Generation.*\n\n---\n\n## ๐Ÿ”— Requirement Traceability\n\n> Every functional requirement (FR) from the PRD must map to at least one task.\n\n| FR ID | Task ID(s) | Coverage |\n|:------|:-----------|:---------|\n| โ€” | โ€” | โ€” |\n\n---\n\n*This file is auto-populated. Do not edit manually unless correcting task generation output.*\n`
169
171
  );
170
172
  writeFileIfNotExists(
171
173
  path.join(projectPath, '04_Tasks', 'DEVELOPMENT_CHECKLIST.md'),
172
- `# DEVELOPMENT_CHECKLIST\n\n- [ ] Repo initialized (git)\n- [ ] Build/run instructions exist\n- [ ] Tests added\n- [ ] Lint/format configured\n- [ ] Security basics (secrets, deps)\n`
174
+ `# โœ… DEVELOPMENT CHECKLIST\n\n> **Your task execution tracker.** Work through tasks top-to-bottom in dependency order.\n> Staff_Engineer (Mode B) updates this during Phase 06.\n\n---\n\n## ๐Ÿ“‹ Execution Order\n\n> Tasks listed in dependency-resolved order. **Execute top-to-bottom. Never skip.**\n\n| # | Task ID | Title | Depends On | Status |\n|:--|:--------|:------|:-----------|:-------|\n| โ€” | โ€” | *Awaiting task generation* | โ€” | โณ |\n\n---\n\n## ๐Ÿ“Š Completion Summary\n\n| Metric | Count |\n|:-------|:------|\n| Total Tasks | 0 |\n| โœ… Completed | 0 |\n| ๐Ÿ”„ In Progress | 0 |\n| ๐Ÿšง Blocked | 0 |\n| โณ Remaining | 0 |\n\n---\n\n## ๐ŸŽฏ Phase Milestones\n\n- [ ] Phase 05 โ€” Task Generation complete\n- [ ] Phase 06 โ€” All tasks implemented\n- [ ] Phase 06 โ€” All acceptance criteria verified\n- [ ] Phase 06 โ€” All state files synced\n\n---\n\n*Created: ${now}*\n`
173
175
  );
174
176
  writeFileIfNotExists(
175
177
  path.join(projectPath, '04_Tasks', 'PROGRESS_LOG.md'),
176
- `# PROGRESS_LOG\n\n## ${now}\n- Project created\n`
178
+ `# ๐Ÿ“œ PROGRESS LOG\n\n> **Chronological record of every phase completion.** Each agent appends an entry when finishing its work.\n\n---\n\n## ๐Ÿ“ Entry Format\n\n> Use this structure for every new entry:\n\n\`\`\`\n## YYYY-MM-DDTHH:MM:SSZ\n\n**Phase XX: Phase Name** โ€” Status\n- ๐Ÿค– Agent: agent_name\n- ๐Ÿ“„ Artifact: output artifact\n- ๐Ÿ“Œ Outcomes: summary\n- โš ๏ธ Issues: count or none\n- โžก๏ธ Next: next_agent (Phase XX)\n\`\`\`\n\n---\n\n## ${now}\n\n**Phase 00: Project Initialization** โ€” โœ… Completed\n- ๐Ÿค– Agent: CLI (create-ai-project)\n- ๐Ÿ“„ Artifact: Project scaffold\n- ๐Ÿ“Œ Outcomes: Folder structure created, 14 agents + 14 workflows deployed\n- โš ๏ธ Issues: None\n- โžก๏ธ Next: Idea_Analyst (Phase 01)\n`
177
179
  );
178
180
  writeFileIfNotExists(
179
181
  path.join(projectPath, '04_Tasks', 'RISK_REGISTER.md'),
180
- `# RISK_REGISTER\n\n| Risk | Impact | Likelihood | Mitigation | Owner | Status |\n|---|---|---|---|---|---|\n| | | | | | |\n`
182
+ `# โš ๏ธ RISK REGISTER\n\n> **Track and manage project risks across all phases.** Each agent flags risks during its work.\n\n---\n\n## ๐ŸŽฏ Severity Scale\n\n| Level | Emoji | Description |\n|:------|:------|:------------|\n| Critical | ๐Ÿ”ด | Blocks deployment โ€” immediate action required |\n| High | ๐ŸŸ  | Significant impact โ€” must address before release |\n| Medium | ๐ŸŸก | Notable concern โ€” schedule for resolution |\n| Low | ๐ŸŸข | Minor issue โ€” track and monitor |\n\n---\n\n## ๐Ÿ”ด Active Risks\n\n| ID | Risk Description | Severity | Likelihood | Impact | Mitigation | Owner | Phase | Status |\n|:---|:-----------------|:---------|:-----------|:-------|:-----------|:------|:------|:-------|\n| โ€” | *No risks identified yet* | โ€” | โ€” | โ€” | โ€” | โ€” | โ€” | โ€” |\n\n---\n\n## โœ… Resolved Risks\n\n| ID | Risk | Resolution | Date Resolved |\n|:---|:-----|:-----------|:--------------|\n| โ€” | *None yet* | โ€” | โ€” |\n\n---\n\n*Created: ${now}*\n`
181
183
  );
182
184
  writeFileIfNotExists(
183
185
  path.join(projectPath, '04_Tasks', 'TASKS', 'TEMPLATE_TASK.md'),
184
- `# TASK: <title>\n\n## Goal\n\n## Acceptance criteria\n\n## Steps\n\n## Notes\n`
186
+ `# ๐ŸŽฏ Task XXX: <Title>\n\n> *Copy this template for each new task. Replace XXX with the task number.*\n\n---\n\n## ๐Ÿ“Œ Quick Info\n\n| Field | Value |\n|:------|:------|\n| **Status** | โณ Not Started / ๐Ÿ”„ In Progress / โœ… Complete / ๐Ÿšง Blocked |\n| **Priority** | ๐Ÿ”ด Critical / ๐ŸŸ  High / ๐ŸŸก Medium / ๐ŸŸข Low |\n| **Complexity** | Low / Medium / High |\n\n---\n\n## ๐Ÿ”— Dependencies\n\n> List tasks that must be completed before this one can start.\n\n- TASK_XXX โ€” *(describe what it provides)*\n\n---\n\n## ๐Ÿ“ Description\n\n> Clear, atomic description of what to implement. One concern per task.\n\n*(Write here)*\n\n---\n\n## โœ… Acceptance Criteria\n\n> All must pass before marking this task complete.\n\n- [ ] Criterion 1\n- [ ] Criterion 2\n\n---\n\n## ๐Ÿ› ๏ธ Implementation Notes\n\n> Guidance from architecture. **Do NOT exceed this scope.**\n\n*(Write here)*\n\n---\n\n## ๐Ÿ“‚ Files to Create / Modify\n\n- \`05_Project/path/to/file.ext\`\n\n---\n\n## ๐Ÿ—๏ธ Architecture Reference\n\n> Which section of ARCHITECTURE.md does this task implement?\n\n*(Reference here)*\n\n---\n\n## ๐Ÿ“Š Completion Log\n\n| Field | Value |\n|:------|:------|\n| Started | โ€” |\n| Completed | โ€” |\n| Drift Detected | None |\n| Files Changed | โ€” |\n`
185
187
  );
186
188
 
187
- writeFileIfNotExists(path.join(projectPath, '07_state', 'CHANGELOG.md'), `# CHANGELOG\n\n## Unreleased\n-\n`);
188
- writeFileIfNotExists(path.join(projectPath, '07_state', 'DECISIONS.md'), `# DECISIONS\n\n## ${now}\n- Initial scaffold\n`);
189
+ writeFileIfNotExists(path.join(projectPath, '07_state', 'CHANGELOG.md'), `# ๐Ÿ“œ CHANGELOG\n\n> **All notable changes to this project.** Format follows [Keep a Changelog](https://keepachangelog.com/).\n\n---\n\n## [Unreleased]\n\n### โž• Added\n\n- *(Next changes go here)*\n\n### ๐Ÿ”„ Changed\n\n### ๐Ÿ› Fixed\n\n### ๐Ÿ—‘๏ธ Removed\n\n---\n\n## [0.1.0] โ€” ${now}\n\n### โž• Added\n\n- ๐ŸŽ‰ Project initialized with AI-OS v1.2.0 framework\n- ๐Ÿค– 14 agent definitions deployed\n- ๐Ÿ”„ 14 workflow definitions deployed\n- ๐Ÿ“Š State tracking infrastructure created\n- ๐Ÿ“‹ Task management templates deployed\n\n---\n\n*Agents append to this file after significant changes.*\n`);
190
+ writeFileIfNotExists(path.join(projectPath, '07_state', 'DECISIONS.md'), `# ๐Ÿงญ DECISIONS\n\n> **Every significant decision โ€” who made it, why, and what it affects.**\n> For architectural decisions, also create an entry in \`ADR.md\`.\n\n---\n\n## ๐Ÿ“ Decision Template\n\n> Copy this block for each new decision:\n\n| Field | Value |\n|:------|:------|\n| **Decision ID** | DEC-XXX |\n| **Date** | โ€” |\n| **Phase** | โ€” |\n| **Agent** | โ€” |\n| **Decision** | โ€” |\n| **Rationale** | โ€” |\n| **Impact** | โ€” |\n| **ADR Link** | ADR-XXX *(if architectural)* |\n\n---\n\n## DEC-001\n\n| Field | Value |\n|:------|:------|\n| **Decision ID** | DEC-001 |\n| **Date** | ${now} |\n| **Phase** | Initialization |\n| **Agent** | CLI (create-ai-project) |\n| **Decision** | Project scaffolded with AI-OS v1.2.0 framework |\n| **Rationale** | Standard initialization for structured AI-driven development |\n| **Impact** | 11-phase pipeline established with 14 agents |\n| **ADR Link** | ADR-0001 |\n`);
189
191
  writeFileIfNotExists(
190
192
  path.join(projectPath, '07_state', 'ADR.md'),
191
- `# ADR (Architecture Decision Records)\n\n### ADR-0001: <Title>\n- Date: ${now}\n- Status: Proposed | Accepted | Superseded\n\n#### Context\n\n#### Decision\n\n#### Consequences\n\n---\n`
193
+ `# ๐Ÿ›๏ธ Architecture Decision Records (ADR)\n\n> **Immutable records of architectural choices.** Once accepted, an ADR is never edited โ€” only superseded by a new one.\n\n---\n\n## ๐Ÿ“ ADR Template\n\n> Copy this block for each new architecture decision:\n\n### ADR-XXXX: <Title>\n\n| Field | Value |\n|:------|:------|\n| **Date** | โ€” |\n| **Status** | ๐Ÿ“‹ Proposed / โœ… Accepted / โš ๏ธ Deprecated / ๐Ÿ”„ Superseded |\n| **Phase** | โ€” |\n| **Agent** | โ€” |\n| **Supersedes** | โ€” |\n| **Superseded By** | โ€” |\n\n#### ๐Ÿ” Context\n*What problem or question motivated this decision?*\n\n#### โœ… Decision\n*What change are we making?*\n\n#### ๐Ÿ“Š Consequences\n*What becomes easier or harder?*\n\n#### ๐Ÿ”— Governance Link\n*Reference to \`workflow_governance_rules.md\` if applicable.*\n\n---\n\n## ADR-0001: Project Initialization\n\n| Field | Value |\n|:------|:------|\n| **Date** | ${now} |\n| **Status** | โœ… Accepted |\n| **Phase** | Initialization |\n| **Agent** | CLI (create-ai-project) |\n\n#### ๐Ÿ” Context\nNew project requires a structured, agent-driven development framework.\n\n#### โœ… Decision\nScaffolded using create-ai-project CLI with AI-OS v1.2.0 framework โ€” 11 phases, 14 agents, 14 workflows.\n\n#### ๐Ÿ“Š Consequences\n- All agents and workflows immediately available\n- Phase-based pipeline enforced from day one\n- State tracking operational\n\n---\n`
192
194
  );
193
- writeFileIfNotExists(path.join(projectPath, '07_state', 'KNOWN_ISSUES.md'), `# KNOWN_ISSUES\n\n-\n`);
194
- writeFileIfNotExists(path.join(projectPath, '07_state', 'INCIDENT_LOG.md'), `# INCIDENT_LOG\n\n-\n`);
195
+ writeFileIfNotExists(path.join(projectPath, '07_state', 'KNOWN_ISSUES.md'), `# ๐Ÿ› KNOWN ISSUES\n\n> **Track all known issues across the project lifecycle.** Agents log issues as they discover them.\n\n---\n\n## ๐Ÿ“ Issue Template\n\n> Copy this for each new issue:\n\n| Field | Value |\n|:------|:------|\n| **Issue ID** | ISS-XXX |\n| **Severity** | ๐Ÿ”ด Critical / ๐ŸŸ  High / ๐ŸŸก Medium / ๐ŸŸข Low |\n| **Phase Discovered** | โ€” |\n| **Agent** | โ€” |\n| **Description** | โ€” |\n| **Impact** | โ€” |\n| **Workaround** | โ€” |\n| **Resolution** | โ€” |\n| **Status** | ๐Ÿ”“ Open / ๐Ÿ”„ In Progress / โœ… Resolved / ๐Ÿšซ Won't Fix |\n\n---\n\n## ๐Ÿ”“ Active Issues\n\n> *No known issues at this time.* ๐ŸŽ‰\n\n---\n\n## โœ… Resolved Issues\n\n> *Nothing resolved yet โ€” project is brand new!*\n\n---\n\n*Agents append issues here automatically during their phases.*\n`);
196
+ writeFileIfNotExists(path.join(projectPath, '07_state', 'INCIDENT_LOG.md'), `# ๐Ÿšจ INCIDENT LOG\n\n> **Production incidents and their resolution.** Used post-deployment to track outages, bugs, and recovery.\n\n---\n\n## ๐Ÿ“ Incident Template\n\n> Copy this for each incident:\n\n| Field | Value |\n|:------|:------|\n| **Incident ID** | INC-XXX |\n| **Date** | โ€” |\n| **Severity** | ๐Ÿ”ด P0 (Critical) / ๐ŸŸ  P1 (High) / ๐ŸŸก P2 (Medium) / ๐ŸŸข P3 (Low) |\n| **Description** | โ€” |\n| **Root Cause** | โ€” |\n| **Impact** | โ€” |\n| **Resolution** | โ€” |\n| **Time to Detect** | โ€” |\n| **Time to Resolve** | โ€” |\n| **Postmortem** | โ€” |\n| **Prevention** | โ€” |\n\n---\n\n## ๐Ÿ“‹ Incidents\n\n> *No incidents recorded.* ๐ŸŽ‰ *This is a brand-new project!*\n\n---\n\n*This file becomes active after deployment (Phase 11).*\n`);
195
197
 
196
198
  // Copy bundled 02_Skills (actual full content) into the project.
197
199
  if (!fs.existsSync(SKILLS_TEMPLATE_SOURCE)) {
@@ -202,11 +204,14 @@ function main() {
202
204
  }
203
205
  copyRecursiveNoClobber(SKILLS_TEMPLATE_SOURCE, path.join(projectPath, '02_Skills'));
204
206
 
205
- // README
206
- writeFileIfNotExists(
207
- path.join(projectPath, 'README.md'),
208
- `# ${projectName}\n\nGenerated by **create-ai-project** (AI-OS).\n\n## Quickstart\n\n\`\`\`bash\ncd \"${projectName}\"\n\`\`\`\n\n## Where things go\n\n- \`02_Skills/\` โ€” standard skills shipped with initializer (ignored by git in this scaffold)\n- \`03_Project_Info/\` โ€” role folders (agents will generate/update docs later)\n- \`06_Documentation/\` โ€” system docs (generated later)\n- \`04_Tasks/\` โ€” task plans + logs\n- \`07_state/\` โ€” decisions + ADR + changelog\n\n## Python default: uv\n\n\`\`\`bash\ncd 05_Project\nuv venv\nuv pip install <pkg>\n\`\`\`\n\nGenerated: ${now}\n`
209
- );
207
+ // Copy CLI package README into the project for reference
208
+ const cliReadmePath = path.join(__dirname, 'README.md');
209
+ if (fs.existsSync(cliReadmePath)) {
210
+ writeFileIfNotExists(
211
+ path.join(projectPath, 'CLI_PACKAGE_README.md'),
212
+ fs.readFileSync(cliReadmePath, 'utf8')
213
+ );
214
+ }
210
215
 
211
216
  writeFileIfNotExists(
212
217
  path.join(projectPath, '05_Project', 'README.md'),
package/package.json CHANGED
@@ -1,7 +1,11 @@
1
1
  {
2
2
  "name": "@akm1923main/init-project",
3
- "version": "1.0.0",
4
- "description": "AI-OS project initializer CLI",
3
+ "version": "1.2.0",
4
+ "description": "An enterprise-grade project scaffolder for bootstrapping AI-OS (Artificial Intelligence Operating System) projects with a comprehensive suite of pre-built agent skills and development workflows.",
5
+ "author": {
6
+ "name": "akm1923main",
7
+ "url": "https://github.com/akm1923main"
8
+ },
5
9
  "main": "index.js",
6
10
  "type": "commonjs",
7
11
  "license": "MIT",
@@ -20,5 +24,13 @@
20
24
  "cli",
21
25
  "ai",
22
26
  "project"
23
- ]
24
- }
27
+ ],
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/akm1923main/init-project"
31
+ },
32
+ "bugs": {
33
+ "url": "https://github.com/akm1923main/init-project/issues"
34
+ },
35
+ "homepage": "https://github.com/akm1923main/init-project#readme"
36
+ }