@kiroku-solutions/kiroku-ai 0.2.1 → 0.2.2
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 +28 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,6 +48,7 @@ pnpm --dir CLI start init
|
|
|
48
48
|
| `init` | Pick a setup mode, then download skills into the engine's folders. |
|
|
49
49
|
| `update` | Re-resolves the recorded stack, re-downloads, and prunes removed skills. |
|
|
50
50
|
| `env [tool]` | Switches the AI tool: **migrates the folders** and regenerates its pointer. |
|
|
51
|
+
| `scaffold` | Generates a runnable starter project for the recorded stack (Phase 2). |
|
|
51
52
|
|
|
52
53
|
### Setup modes
|
|
53
54
|
|
|
@@ -84,6 +85,33 @@ pointer file an **Engineering approach** the AI must follow:
|
|
|
84
85
|
The matching docs come from `skills/architecture/`, `skills/methodology/` and
|
|
85
86
|
`skills/practices/` in the SSOT and install under your tool's skills folder.
|
|
86
87
|
|
|
88
|
+
### Scaffolding a starter project (Phase 2)
|
|
89
|
+
|
|
90
|
+
After `init` you can optionally generate a **runnable starter repo** for your
|
|
91
|
+
stack (it also asks at the end of `init`, defaulting to no):
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
kiroku-ai scaffold # reads .kiroku-ai/lockfile.json
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Generators used (official where they exist; our own templates otherwise):
|
|
98
|
+
|
|
99
|
+
| Stack piece | How it's generated | Needs |
|
|
100
|
+
| ----------- | -------------------------------------------------------------- | ------- |
|
|
101
|
+
| Next.js | `npx create-next-app@latest <dir> --yes --skip-install --disable-git` | `npx` |
|
|
102
|
+
| Astro | `npm create astro@latest <dir> -- --template minimal -y --no-install --no-git` | `npm` |
|
|
103
|
+
| SvelteKit | `npx sv create <dir> --template minimal --types ts --no-install` | `npx` |
|
|
104
|
+
| .NET | `dotnet new webapi -o <dir>` | `dotnet`|
|
|
105
|
+
| FastAPI | template `CLI/templates/scaffold/fastapi/` | — |
|
|
106
|
+
| Java | template `CLI/templates/scaffold/java/` | — |
|
|
107
|
+
|
|
108
|
+
For **fullstack** projects you pick the layout (`apps/web`+`apps/api`,
|
|
109
|
+
`frontend`+`backend`, or custom names); single-scope projects scaffold at the
|
|
110
|
+
root. Dependencies are **not** installed automatically — a next-steps note tells
|
|
111
|
+
you how. If a required toolchain (e.g. `dotnet`) is missing, that piece is
|
|
112
|
+
skipped with a clear message and the rest still runs. Existing non-empty target
|
|
113
|
+
folders are never overwritten.
|
|
114
|
+
|
|
87
115
|
### AI environments
|
|
88
116
|
|
|
89
117
|
During `init` you pick the AI tool the project targets. The CLI installs into
|