buildx-cli 1.8.21 → 1.8.23

package/README.md

@@ -227,8 +227,9 @@ Modes:
 - `product`: tries `POST /product/:product_key/projects`, then falls back to `plain` when product creation is denied (for example non-root auth).
 
 Key options:
-- `--project-id <id>`: target project ID (required)
-- `--name <name>`: project name (required)
+- `-i, --interactive`: prompt for missing options (recommended for first-time setup)
+- `--project-id <id>`: target project ID (required unless interactive prompt is used)
+- `--name <name>`: project name (required unless interactive prompt is used)
 - `--description <text>`: project description (optional)
 - `--product-key <key>`: enable product mode first, with fallback to plain mode
 - `--app <none|next|expo|react>`: app scaffold target (default `none`)
@@ -244,6 +245,9 @@ Examples:
 # backend only (plain mode)
 npx buildx-cli project:init --project-id hello-world --name "Hello World"
 
+# interactive guided mode
+npx buildx-cli project:init --interactive
+
 # product mode first, fallback to plain when not allowed
 npx buildx-cli project:init --project-id hello-world --name "Hello World" --product-key approval
 
@@ -255,12 +259,18 @@ npx buildx-cli project:init --project-id hello-world --name "Hello World" --app
 ```
 
 Generated auth-aware structure:
+- Next.js scaffold source:
+  - `project:init --app next` runs `npx create-next-app@latest` first (TypeScript + App Router)
+  - then applies Buildx auth/public-private route wiring and maintenance scripts
 - Next.js template uses route groups for separation:
   - `app/(public)/...` (sign-in/sign-up/forgot-password)
   - `app/(private)/...` (protected dashboard)
 - Expo template uses auth-state route split in `App.tsx`:
   - public screen tree for unauthenticated users
   - private screen tree for authenticated users
+- Scaffold layout is single-level:
+  - app package files are generated at workspace root (no `apps/web` nesting)
+  - `buildx/` artifacts are generated at root level alongside app files
 
 UI package dependency resolution:
 - generated apps depend on package from env `BUILDX_UI_PACKS_PACKAGE`
@@ -268,6 +278,10 @@ UI package dependency resolution:
 - set a scoped package before seeding when unscoped npm name is unavailable:
   - `BUILDX_UI_PACKS_PACKAGE=@your-scope/buildx-react-ui-packs npx buildx-cli project:init ...`
 
+Notes:
+- Next scaffold requires npm registry connectivity for `create-next-app`.
+- Use `--dry-run` to preview file plan without running scaffold commands.
+
 ### New Project Maintenance
 
 After `project:init`, use these commands to maintain local/remote artifact parity:

package/dist/README.md

@@ -227,8 +227,9 @@ Modes:
 - `product`: tries `POST /product/:product_key/projects`, then falls back to `plain` when product creation is denied (for example non-root auth).
 
 Key options:
-- `--project-id <id>`: target project ID (required)
-- `--name <name>`: project name (required)
+- `-i, --interactive`: prompt for missing options (recommended for first-time setup)
+- `--project-id <id>`: target project ID (required unless interactive prompt is used)
+- `--name <name>`: project name (required unless interactive prompt is used)
 - `--description <text>`: project description (optional)
 - `--product-key <key>`: enable product mode first, with fallback to plain mode
 - `--app <none|next|expo|react>`: app scaffold target (default `none`)
@@ -244,6 +245,9 @@ Examples:
 # backend only (plain mode)
 npx buildx-cli project:init --project-id hello-world --name "Hello World"
 
+# interactive guided mode
+npx buildx-cli project:init --interactive
+
 # product mode first, fallback to plain when not allowed
 npx buildx-cli project:init --project-id hello-world --name "Hello World" --product-key approval
 
@@ -255,12 +259,18 @@ npx buildx-cli project:init --project-id hello-world --name "Hello World" --app
 ```
 
 Generated auth-aware structure:
+- Next.js scaffold source:
+  - `project:init --app next` runs `npx create-next-app@latest` first (TypeScript + App Router)
+  - then applies Buildx auth/public-private route wiring and maintenance scripts
 - Next.js template uses route groups for separation:
   - `app/(public)/...` (sign-in/sign-up/forgot-password)
   - `app/(private)/...` (protected dashboard)
 - Expo template uses auth-state route split in `App.tsx`:
   - public screen tree for unauthenticated users
   - private screen tree for authenticated users
+- Scaffold layout is single-level:
+  - app package files are generated at workspace root (no `apps/web` nesting)
+  - `buildx/` artifacts are generated at root level alongside app files
 
 UI package dependency resolution:
 - generated apps depend on package from env `BUILDX_UI_PACKS_PACKAGE`
@@ -268,6 +278,10 @@ UI package dependency resolution:
 - set a scoped package before seeding when unscoped npm name is unavailable:
   - `BUILDX_UI_PACKS_PACKAGE=@your-scope/buildx-react-ui-packs npx buildx-cli project:init ...`
 
+Notes:
+- Next scaffold requires npm registry connectivity for `create-next-app`.
+- Use `--dry-run` to preview file plan without running scaffold commands.
+
 ### New Project Maintenance
 
 After `project:init`, use these commands to maintain local/remote artifact parity: