@nexus-framework/cli 0.1.1 → 0.1.2

package/README.md

@@ -8,10 +8,9 @@
 
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 [![Node.js](https://img.shields.io/badge/Node.js-20+-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
-[![Vitest](https://img.shields.io/badge/Vitest-73%2F73_Passing-green?style=for-the-badge&logo=vitest&logoColor=white)](https://vitest.dev/)
+[![Vitest](https://img.shields.io/badge/Vitest-105_Passing-green?style=for-the-badge&logo=vitest&logoColor=white)](https://vitest.dev/)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge)](LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen?style=for-the-badge)](https://github.com/GDA-Africa/nexus-cli/pulls)
-[![Status](https://img.shields.io/badge/Status-In_Development-yellow?style=for-the-badge)]()
 
 ---
 
@@ -23,22 +22,20 @@
 
 ## 🌍 About GDA Africa
 
-**GDA (Glenhalton Digital Agency)** is building the digital infrastructure for Africa's next generation of products and services. **NEXUS CLI** is the foundational developer tool in GDA's ecosystem — a free, open-source scaffolding engine that generates intelligent project structures where AI and humans collaborate seamlessly from day one.
+**GDA (Glenhalton Digital Agency)** is building the digital infrastructure for Africa's next generation of products and services. NEXUS CLI is GDA's open-source developer tool — a scaffolding engine that generates intelligent project structures where AI and humans collaborate from day one.
 
 ---
 
-## 🎯 Why NEXUS CLI?
+## 🎯 Why NEXUS?
 
-Every new project starts with the same painful ritual: hours of boilerplate, fragmented configs, and zero documentation. NEXUS eliminates all of that.
+Every new project starts with the same ritual: hours of boilerplate, fragmented configs, and zero documentation. NEXUS eliminates all of that.
 
 | Problem | NEXUS Solution |
 |---|---|
-| 🕐 Starting a project takes hours of setup and configuration guesswork | **2-minute interactive setup** with strategy-first questions and smart defaults |
-| 🤖 AI coding tools (Cursor, Copilot) struggle with project-wide context | **AI-optimized documentation system** — 8 structured files AI agents can parse and execute |
-| 🧩 Every project structure is different, making team consistency impossible | **Standardized, production-ready scaffolding** based on proven architectural patterns |
-| 🧪 Tests and documentation are always afterthoughts | **Test infrastructure and docs generated from day one** — not bolted on later |
-| 📚 Onboarding new developers takes weeks, knowledge silos form | **Self-documenting projects** where the codebase explains itself to humans and AI alike |
-| 🔄 No established conventions exist for AI-native development | **The first framework built for the AI era** — bridging requirements and code generation |
+| 🕐 Hours of setup and config guesswork to start a project | **2-minute interactive setup** with strategy-first questions and smart defaults |
+| 🤖 AI tools (Cursor, Copilot) have no project-wide context | **8 structured doc files** AI agents can parse, execute, and auto-populate |
+| 🧪 Tests and docs are always afterthoughts | **Generated from day one** — test infrastructure, CI/CD, and documentation included |
+| 🔄 No conventions exist for AI-native development | **The first framework built for the AI era** — bridging requirements and code generation |
 
 ---
 
@@ -51,20 +48,19 @@ Every new project starts with the same painful ritual: hours of boilerplate, fra
 ### Core Capabilities
 - 🧠 **Strategy-First Setup** — Asks about your goals, not just tech preferences
 - 📐 **Complete Scaffolding** — Production-ready structure, not hello world
-- 📚 **NEXUS Doc System** — 8 structured markdown files AI agents understand
+- 📚 **NEXUS Doc System** — 8 AI-optimized markdown files per project
 - 🎯 **Smart Defaults** — Best practices baked in based on your choices
-- 🧪 **Test Infrastructure** — Vitest config, example tests, and helpers from the start
-- 🏗️ **Adopt Existing Projects** — Add NEXUS docs & AI config to any project with `--adopt`
+- 🧪 **Test Infrastructure** — Vitest config, example tests, and helpers included
 
 </td>
 <td width="50%">
 
 ### Production Ready
-- ⚡ **Multi-Framework Support** — Next.js, React+Vite, SvelteKit, Nuxt, Astro
+- ⚡ **5 Frameworks** — Next.js, React+Vite, SvelteKit, Nuxt, Astro
 - 🔧 **Full Toolchain** — TypeScript, ESLint, Prettier pre-configured
-- 🚀 **CI/CD Templates** — GitHub Actions workflows generated automatically
-- 🌐 **Cross-Platform** — Works on macOS, Windows (WSL), and Linux
-- 📦 **Strategy Patterns** — PWA, Offline-First, i18n, Theming, White Label, Real-time
+- 🚀 **CI/CD Templates** — GitHub Actions workflows out of the box
+- 🏗️ **Adopt Existing Projects** — Add NEXUS to any codebase with `nexus adopt`
+- 📦 **Strategy Patterns** — PWA, Offline-First, i18n, Theming, Real-time
 
 </td>
 </tr>
@@ -72,464 +68,120 @@ Every new project starts with the same painful ritual: hours of boilerplate, fra
 
 ---
 
-## 🏗️ Architecture
-
-```
-┌──────────────────────────────────────────────────────────────┐
-│                        NEXUS CLI                             │
-│              nexus init <project-name>                        │
-└──────────────────────┬───────────────────────────────────────┘
-                       │
-                       ▼
-┌──────────────────────────────────────────────────────────────┐
-│                   INTERACTIVE PROMPTS                         │
-│  ┌─────────────┐ ┌──────────────┐ ┌────────────────────┐    │
-│  │ Project Type │ │Data Strategy │ │ Application Pattern│    │
-│  │ Web/API/Mono │ │Local/Cloud/  │ │ PWA/Offline/i18n/  │    │
-│  │              │ │Hybrid        │ │ Theming            │    │
-│  └──────┬──────┘ └──────┬───────┘ └─────────┬──────────┘    │
-│         │    ┌──────────┐│┌───────────┐      │               │
-│         │    │ Framework ││ Features & │      │               │
-│         │    │ Selection ││  Extras    │      │               │
-│         │    └─────┬────┘│└─────┬─────┘      │               │
-│         └──────────┼─────┼──────┼────────────┘               │
-└────────────────────┼─────┼──────┼────────────────────────────┘
-                     │     │      │  NexusConfig
-                     ▼     ▼      ▼
-┌──────────────────────────────────────────────────────────────┐
-│                   GENERATOR ENGINE                            │
-│  ┌───────────┐ ┌───────────┐ ┌──────────┐ ┌─────────────┐  │
-│  │ Structure  │ │   Docs    │ │  Config  │ │   Tests     │  │
-│  │ Generator  │ │ Generator │ │Generator │ │  Generator  │  │
-│  └─────┬─────┘ └─────┬─────┘ └────┬─────┘ └──────┬──────┘  │
-│        │    ┌─────────┘            │               │         │
-│        │    │    ┌─────────────────┘               │         │
-│        │    │    │    ┌────────────────────────────┘         │
-│        ▼    ▼    ▼    ▼                                      │
-│  ┌──────────────────────────┐                                │
-│  │       CI/CD Generator    │                                │
-│  └──────────────────────────┘                                │
-└──────────────────────┬───────────────────────────────────────┘
-                       │  Write to disk
-                       ▼
-┌──────────────────────────────────────────────────────────────┐
-│                YOUR NEW PROJECT  ✨                           │
-│                                                              │
-│  📁 src/           Source code with smart boilerplate        │
-│  � .nexus/        Docs, AI config, manifest — one folder   │
-│  🧪 tests/         Unit, integration, and E2E scaffolding   │
-│  ⚙️  configs        TS, ESLint, Prettier, CI/CD              │
-│  📦 package.json   Dependencies installed & ready            │
-│                                                              │
-│  → npm run dev     Your app is running.                      │
-└──────────────────────────────────────────────────────────────┘
-```
-
----
-
-## 📁 Project Structure
-
-```
-@nexus-framework/cli/
-├── bin/
-│   └── nexus.js              # Executable entry point (shebang)
-├── src/
-│   ├── cli.ts                # CLI entry point — Commander.js setup
-│   ├── index.ts              # Public API exports for programmatic usage
-│   ├── version.ts            # Single source of truth for CLI version
-│   ├── commands/
-│   │   ├── init.ts           # `nexus init` — main scaffolding command
-│   │   └── adopt.ts          # `nexus adopt` — add NEXUS to existing projects
-│   ├── prompts/
-│   │   ├── index.ts          # Prompt orchestrator — assembles NexusConfig
-│   │   ├── project-type.ts   # Web / API / Monorepo selection
-│   │   ├── data-strategy.ts  # Local Only / Local First / Cloud / Hybrid
-│   │   ├── patterns.ts       # PWA, Offline-First, i18n, Theming, Real-time
-│   │   ├── frameworks.ts     # Next.js, React+Vite, SvelteKit, Nuxt, Astro
-│   │   └── features.ts       # Testing, package manager, git, install prefs
-│   ├── generators/
-│   │   ├── index.ts          # Generator orchestrator — runs all generators
-│   │   ├── structure.ts      # Folder structure, package.json, README, .gitignore
-│   │   ├── docs.ts           # 8 NEXUS doc files → .nexus/docs/ + index + manifest
-│   │   ├── config.ts         # tsconfig, ESLint, Prettier, EditorConfig
-│   │   ├── tests.ts          # Vitest config, example tests, test helpers
-│   │   ├── ci-cd.ts          # GitHub Actions CI workflow
-│   │   ├── landing-page.ts   # Framework-specific homepage + SVG logo/favicon
-│   │   └── ai-config.ts      # AI agent instructions → .nexus/ai/ + root pointers
-│   ├── types/
-│   │   ├── index.ts          # Re-exports for convenience
-│   │   ├── config.ts         # NexusConfig, NexusManifest, union types
-│   │   ├── prompts.ts        # Prompt answer interfaces
-│   │   └── templates.ts      # GeneratedFile, GeneratorResult, TemplateContext
-│   └── utils/
-│       ├── index.ts          # Re-exports for convenience
-│       ├── logger.ts         # Chalk-powered branded terminal output
-│       ├── validator.ts      # Project name validation and sanitization
-│       ├── package-manager.ts # npm / yarn / pnpm detection
-│       ├── git.ts            # Git init and initial commit helpers
-│       ├── file-system.ts    # fs-extra wrappers and Mustache rendering
-│       └── project-detector.ts # Detect existing projects for --adopt mode
-├── tests/
-│   └── unit/
-│       ├── validator.test.ts # 15 tests — name validation, sanitization
-│       ├── generators.test.ts # 30 tests — structure, package.json, gitignore, landing pages, ai-config
-│       └── adopt.test.ts     # 28 tests — project detection, frontmatter, AI onboarding
-├── .nexus/
-│   ├── docs/
-│   │   ├── index.md          # Project brain — status, module map, priorities
-│   │   ├── 01_vision.md      # Product vision and requirements
-│   │   └── 07_implementation.md # Technical architecture and build plan
-│   └── ai/
-│       └── instructions.md   # AI agent master instructions (single source of truth)
-├── package.json              # Dependencies, scripts, and npm metadata
-├── tsconfig.json             # TypeScript strict mode, ESM (NodeNext)
-├── vitest.config.ts          # Test runner with coverage thresholds
-├── .eslintrc.cjs             # ESLint + TypeScript + Prettier config
-├── .prettierrc               # Code formatting rules
-├── .gitignore                # Node, dist, IDE, OS ignores
-├── .cursorrules              # AI pointer → .nexus/ai/instructions.md (Cursor)
-├── .windsurfrules            # AI pointer → .nexus/ai/instructions.md (Windsurf)
-├── .clinerules               # AI pointer → .nexus/ai/instructions.md (Cline)
-├── AGENTS.md                 # AI pointer → .nexus/ai/instructions.md (Claude/Codex)
-├── LICENSE                   # Apache 2.0
-├── README_GUIDELINES.md      # GDA README standards reference
-└── README.md                 # You are here
-```
-
----
-
 ## 🚀 Quick Start
 
-### Prerequisites
-- **Node.js** 20+ (LTS recommended)
-- **npm** 9+, **yarn** 1.x+, or **pnpm** 8+
-- **Git** 2.x+
-
-### 1. Clone & Setup
+### Install
 
 ```bash
-git clone https://github.com/GDA-Africa/nexus-cli.git
-cd nexus-cli
-yarn install
+npm install -g @nexus-framework/cli
 ```
 
-### 2. Build
+### Create a Project
 
 ```bash
-yarn build
+nexus init my-app
 ```
 
-### 3. Run the CLI
+You'll be guided through an interactive setup:
 
-```bash
-node bin/nexus.js init my-awesome-app
 ```
+🔮 NEXUS CLI v0.1.2 — AI-Native Project Scaffolding
 
-You'll be guided through an interactive setup:
+? What are you building?                › Web Application
+? How will your app handle data?        › Cloud First
+? Which application patterns?           › PWA, Theming
+? Which frontend framework?             › Next.js 15 (App Router)
+? Testing framework?                    › Vitest
+? Package manager?                      › npm
+? Initialize a git repository?          › Yes
+? Install dependencies now?             › Yes
 
-```
-  🔮 NEXUS CLI v0.1.0
-  AI-Native Project Scaffolding
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-
-? What are you building? › Web Application
-? How will your app handle data? › Cloud First
-? Which application patterns do you need? › PWA, Theming
-? Which frontend framework? › Next.js 15 (App Router)
-? Testing framework? › Vitest
-? Package manager? › npm
-? Initialize a git repository? › Yes
-? Install dependencies now? › Yes
-
-▸ NEXUS Creating "my-awesome-app" with nextjs...
-
-✔ Project structure generated.
-✔ Dependencies installed.
-✔ Git repository initialized.
-
-  ✅ Project created successfully!
-
-  Next steps:
-    cd my-awesome-app
-    npm run dev
+✔ Project created successfully!
+
+  cd my-app
+  npm run dev
 ```
 
-### 4. Verify
+### Run It
 
 ```bash
-cd my-awesome-app
+cd my-app
 npm run dev
 # → Your app is running at http://localhost:3000
 ```
 
 ---
 
-## 🏗️ Adopt an Existing Project
-
-Already have a project? NEXUS can add its documentation system and AI configuration to any existing codebase without modifying your source code.
+## 📦 What You Get
 
-```bash
-# Navigate to your existing project
-cd my-existing-app
+Every generated project includes:
 
-# Add NEXUS docs & AI config
-nexus adopt
-
-# Or target a specific directory
-nexus adopt ./path/to/project
-```
-
-> **Tip:** `nexus init --adopt` also works as a shorthand — both reach the same code path. If you run `nexus init` in a directory that already has a project, NEXUS will detect it and suggest `nexus adopt` instead.
-
-### What `nexus adopt` does
-
-| Generated | What It Contains |
-|---|---|
-| `.nexus/docs/` | 8 structured documentation files with `status: template` frontmatter |
-| `.nexus/ai/` | AI agent instructions (single source of truth) |
-| `.cursorrules`, `.windsurfrules`, `.clinerules` | AI tool pointers |
-| `AGENTS.md` | Claude / Codex pointer |
-| `.github/copilot-instructions.md` | GitHub Copilot config |
-
-### What `nexus adopt` does NOT do
-
-- ❌ Does **not** modify any of your existing source code
-- ❌ Does **not** create `package.json`, `tsconfig.json`, or any config files
-- ❌ Does **not** install dependencies or initialize git
-
-### Auto-Population by AI Agents
-
-After adopting, open your AI coding tool (Copilot, Cursor, Windsurf, etc.) and start working as usual. The AI agent will:
-
-1. **Detect** that NEXUS docs have `status: template` in their frontmatter
-2. **Scan your codebase** to auto-populate architecture, data contracts, API routes, test strategy, and deployment info
-3. **Ask you questions** for things it can't infer from code (product vision, business rules, success metrics)
-4. **Update the frontmatter** to `status: populated` as each doc is filled in
-
-Once all docs are populated, the onboarding flow completes and the agent works normally with full project context.
-
----
-
-## 📡 API Reference
-
-NEXUS CLI exposes a programmatic API for advanced usage and tooling integration.
-
-```typescript
-import { runPrompts, generateProject } from '@nexus-framework/cli';
-
-const config = await runPrompts('my-app');
-await generateProject(config);
-```
-
-### CLI Commands
-
-| Command | Description |
+| Output | What's Inside |
 |---|---|
-| `nexus init [project-name]` | Initialize a new NEXUS project with interactive setup |
-| `nexus adopt [path]` | Add NEXUS docs & AI config to an existing project |
-| `nexus init --adopt` | Shorthand alias for `nexus adopt` |
-| `nexus --version` | Display the CLI version |
-| `nexus --help` | Display available commands and options |
-
-### NexusConfig Interface
-
-| Field | Type | Required | Description |
-|---|---|---|---|
-| `projectName` | `string` | ✅ | Name of the project (valid npm package name) |
-| `projectType` | `'web' \| 'api' \| 'monorepo'` | ✅ | Type of project |
-| `dataStrategy` | `'local-only' \| 'local-first' \| 'cloud-first' \| 'hybrid'` | ✅ | Data handling approach |
-| `appPatterns` | `AppPattern[]` | ✅ | Selected application patterns |
-| `frontendFramework` | `'nextjs' \| 'react-vite' \| 'sveltekit' \| 'nuxt' \| 'astro'` | ✅ | Frontend framework |
-| `testFramework` | `'vitest' \| 'jest' \| 'none'` | ✅ | Test framework choice |
-| `packageManager` | `'npm' \| 'yarn' \| 'pnpm'` | ✅ | Package manager to use |
-| `git` | `boolean` | ✅ | Whether to initialize git |
-| `installDeps` | `boolean` | ✅ | Whether to install dependencies |
+| `src/` | Framework-specific source code and landing page |
+| `.nexus/docs/` | 8 AI-optimized documentation files (vision, architecture, API contracts, test strategy, etc.) |
+| `.nexus/ai/` | AI agent instructions — Copilot, Cursor, Windsurf, Cline all auto-detect these |
+| `tests/` | Vitest config, example tests, and test helpers |
+| `package.json` | Real dependencies, real scripts — `npm run dev` works immediately |
+| CI/CD | GitHub Actions workflow for lint, test, and build |
+| Config | TypeScript, ESLint, Prettier, EditorConfig — all pre-configured |
 
 ---
 
-## 🔐 Security
-
-| Layer | Implementation |
-|---|---|
-| **Input Validation** | All project names sanitized via `validate-npm-package-name` and custom validators |
-| **Dependency Auditing** | Generated projects include `npm audit` in CI/CD pipelines |
-| **Secret Management** | `.env` files auto-added to `.gitignore`; environment variable validation on startup |
-| **Code Quality** | ESLint + TypeScript strict mode enabled by default in generated projects |
-| **Supply Chain** | Lockfile pinning and minimal dependency surface in generated projects |
-
----
-
-## 🧪 Testing
-
-NEXUS CLI follows a **test-driven development** philosophy. Every generator and validator is tested.
-
-```bash
-# Run all tests
-yarn test
-
-# Run with coverage
-yarn test:coverage
-
-# Run a specific suite
-npx vitest tests/unit/validator.test.ts
-```
-
-### Test Coverage
-
-| Suite | Tests | Covers |
-|---|---|---|
-| `tests/unit/validator.test.ts` | 15 | Project name validation, sanitization, empty input handling |
-| `tests/unit/generators.test.ts` | 30 | Directory generation, package.json, .gitignore, README, landing pages, ai-config |
-| `tests/unit/adopt.test.ts` | 28 | Project detection, frontmatter status, AI onboarding protocol |
-
-**Current status:** 73/73 tests passing ✅
-
-**Coverage Target:** 80%+ across all suites.
-
----
-
-## 🚢 Deployment
-
-### Publishing to npm
-
-```bash
-yarn build
-npm version patch
-npm publish --access public
-```
+## 🏗️ Adopt an Existing Project
 
-### Installing Globally (End Users)
+Already have a project? Add the NEXUS documentation system and AI config without touching your source code.
 
 ```bash
-npm install -g @nexus-framework/cli
-nexus init my-project
+cd my-existing-app
+nexus adopt
 ```
 
-### Environment Variables
+This adds `.nexus/docs/`, `.nexus/ai/`, and AI tool config files. It does **not** modify your source code, configs, or dependencies.
 
-| Variable | Description | Default |
-|---|---|---|
-| `NEXUS_PACKAGE_MANAGER` | Override package manager detection | Auto-detect |
-| `NEXUS_SKIP_INSTALL` | Skip automatic dependency install after generation | `false` |
+After adopting, your AI coding tool will auto-detect the NEXUS docs, scan your codebase to populate them, and ask you about anything it can't infer — giving the AI full project context from that point forward.
 
 ---
 
-## 🔌 Integration Guide
-
-### Using NEXUS with AI Coding Tools
-
-NEXUS-generated projects are designed to work seamlessly with AI-powered editors:
-
-**Cursor / Copilot / Windsurf:**
-```
-1. Open the generated project
-2. AI tools auto-detect .nexus/ai/instructions.md and root pointer files
-3. Ask your AI to implement features referencing the doc contracts
-4. The AI now has full project context from day one
-```
-
-**Example AI prompt with a NEXUS project:**
-```
-Read .nexus/docs/01_vision.md and .nexus/docs/04_api_contracts.md.
-Implement the user registration endpoint as specified
-in the API contract, following the architecture in
-.nexus/docs/02_architecture.md.
-```
-
-### NEXUS Documentation System
-
-Every generated project includes **8 AI-optimized documentation files** under `.nexus/docs/`:
+## 📖 Supported Frameworks
 
-| # | File | Purpose |
+| Framework | Version | Notes |
 |---|---|---|
-| 1 | `.nexus/docs/01_vision.md` | Product requirements, user stories, success metrics |
-| 2 | `.nexus/docs/02_architecture.md` | System design, tech stack decisions, data flow |
-| 3 | `.nexus/docs/03_data_contracts.md` | Database schemas, validation rules, relationships |
-| 4 | `.nexus/docs/04_api_contracts.md` | Endpoints, request/response interfaces, status codes |
-| 5 | `.nexus/docs/05_business_logic.md` | Rules, algorithms, state machines, decision flows |
-| 6 | `.nexus/docs/06_test_strategy.md` | Coverage targets, test types, testing philosophy |
-| 7 | `.nexus/docs/07_implementation.md` | Build order, file-by-file implementation plan |
-| 8 | `.nexus/docs/08_deployment.md` | Infrastructure, CI/CD, environment configuration |
-
-Plus `.nexus/index.md` dashboard, `.nexus/manifest.json` for machine navigation, and `.nexus/ai/instructions.md` for AI agent context.
+| **Next.js** | 15 (App Router) | React Server Components, Turbopack |
+| **React + Vite** | React 19 + Vite 6 | SWC, fast HMR |
+| **SvelteKit** | 2.x | Svelte 5, file-based routing |
+| **Nuxt** | 3.x | Vue 3, auto-imports |
+| **Astro** | 5.x | Content-first, island architecture |
 
 ---
 
 ## 🗺️ Roadmap
 
-- [x] Project vision and product requirements defined
-- [x] Technical architecture and implementation plan documented
-- [x] Documentation system designed (8-file structure)
-- [x] Core CLI infrastructure (Commander.js + @inquirer/prompts)
-- [x] Interactive prompt system (project type, data strategy, patterns, framework, features)
-- [x] Generator engine (structure, docs, config, tests, CI/CD, landing page, ai-config)
-- [x] Utility layer (logger, validator, package-manager, git, file-system)
-- [x] Type system (NexusConfig, NexusManifest, prompt and template types)
-- [x] Unit tests (45/45 passing — validators and generators)
-- [x] ESLint + Prettier configured and passing
-- [x] Centralized `.nexus/` folder (docs, AI config, manifest — one folder to opt in/out)
+- [x] Core CLI with `nexus init` and `nexus adopt`
+- [x] Interactive prompt system (project type, data strategy, patterns, frameworks)
+- [x] Generator engine (structure, docs, config, tests, CI/CD, landing page, AI config)
+- [x] AI-native documentation system (8 structured files + onboarding protocol)
+- [x] 5 frontend frameworks supported
+- [x] 105 unit tests passing
+- [x] Published to npm as `@nexus-framework/cli`
 - [ ] End-to-end testing of full `nexus init` flow
-- [ ] Framework-specific templates (Next.js 15, React+Vite, SvelteKit)
-- [ ] Strategy pattern generators (PWA, Offline-First, i18n, Theming)
-- [ ] Polish — progress indicators, error recovery, ASCII branding
-- [ ] Cross-platform testing (macOS, Windows WSL, Linux)
-- [ ] Publish to npm as `@nexus-framework/cli`
+- [ ] Strategy pattern generators (PWA service workers, i18n setup, theming engine)
 - [ ] `nexus add <feature>` — add capabilities to existing projects
 - [ ] `nexus validate` — check projects against NEXUS standards
 - [ ] Community templates and plugin system
 
 ---
 
-## 🛠️ Tech Stack
-
-| Component | Technology |
-|---|---|
-| **Runtime** | Node.js 20+ (LTS) |
-| **Language** | TypeScript 5.7 (strict mode, ESM) |
-| **CLI Framework** | Commander.js 12.x |
-| **Interactive Prompts** | @inquirer/prompts 7.x |
-| **Terminal Styling** | Chalk 5.x, Ora 8.x, Figlet 1.x |
-| **Template Engine** | Mustache 4.x |
-| **File System** | fs-extra 11.x |
-| **Shell Execution** | execa 9.x |
-| **Testing** | Vitest 3.x |
-| **Code Quality** | ESLint 8.x, Prettier 3.x |
-| **Package Distribution** | npm (public registry) |
-| **License** | Apache 2.0 |
-
----
-
 ## 🤝 Contributing
 
-NEXUS CLI is open source and we welcome contributions from the community!
-
-### Getting Started
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
 ```bash
-# Fork and clone
-git clone https://github.com/<your-username>/nexus-cli.git
-cd nexus-cli
-yarn install
-
-# Create a branch
-git checkout -b feature/your-feature-name
-
-# Make changes, lint, and test
-yarn lint
-yarn test
-
-# Submit a PR
-git push origin feature/your-feature-name
+git clone https://github.com/GDA-Africa/nexus-cli.git
+cd nexus-cli && yarn install
+yarn lint && yarn test
 ```
 
-### Contribution Guidelines
-
-- **Write tests** for every new feature or bug fix
-- **Follow the code style** — ESLint and Prettier are pre-configured
-- **Update documentation** if your change affects the public API or CLI behavior
-- **One feature per PR** — keep pull requests focused and reviewable
-- **Use conventional commits** — `feat:`, `fix:`, `docs:`, `chore:`
-
 ---
 
 <div align="center">

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAaH,iCAAiC;AACjC,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CA0Df"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAaH,iCAAiC;AACjC,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CA2Df"}

package/dist/commands/init.js

@@ -15,7 +15,7 @@ import { generateProject } from '../generators/index.js';
 import { runPrompts } from '../prompts/index.js';
 import { logger } from '../utils/logger.js';
 import { isExistingProject } from '../utils/project-detector.js';
-import { validateProjectName } from '../utils/validator.js';
+import { validateProjectName, toSlug } from '../utils/validator.js';
 import { version } from '../version.js';
 import { adoptCommand } from './adopt.js';
 /**
@@ -40,9 +40,10 @@ export async function initCommand(projectName, options = {}) {
             process.exit(1);
         }
         // Check if the target directory is an existing project
-        const targetDir = path.resolve(process.cwd(), projectName);
+        const slug = toSlug(projectName);
+        const targetDir = path.resolve(process.cwd(), slug);
         if (isExistingProject(targetDir)) {
-            showAdoptSuggestion(projectName);
+            showAdoptSuggestion(slug);
             process.exit(1);
         }
     }
@@ -55,7 +56,7 @@ export async function initCommand(projectName, options = {}) {
         // Run interactive prompts
         const config = await runPrompts(projectName);
         logger.newline();
-        logger.nexus(`Creating "${config.projectName}" with ${config.frontendFramework}...`);
+        logger.nexus(`Creating "${config.displayName}" with ${config.frontendFramework}...`);
         logger.newline();
         // Generate the project
         await generateProject(config);

package/dist/commands/init.js.map

@@ -1 +1 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAO1C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,WAAoB,EACpB,UAAuB,EAAE;IAEzB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEvB,8DAA8D;IAC9D,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO;IACT,CAAC;IAED,8DAA8D;IAE9D,0CAA0C;IAC1C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,UAAU,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,IAAI,uBAAuB,CAAC,CAAC;YAC5D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,uDAAuD;QACvD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,CAAC;QAC3D,IAAI,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,IAAI,CAAC,WAAW,IAAI,iBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QACrD,mBAAmB,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC;QACH,0BAA0B;QAC1B,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;QAE7C,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,WAAW,UAAU,MAAM,CAAC,iBAAiB,KAAK,CAAC,CAAC;QACrF,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjB,uBAAuB;QACvB,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,oCAAoC;QACpC,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACtE,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC9D,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;oEAEoE;AAEpE,SAAS,mBAAmB,CAAC,WAAoB;IAC/C,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IACzE,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;IACjF,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACtD,MAAM,CAAC,OAAO,EAAE,CAAC;IAEjB,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,CAAC,KAAK,CAAC,iBAAiB,WAAW,EAAE,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1B,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;IAC/E,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;IAClE,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC5E,MAAM,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;IAC/D,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;AACpF,CAAC"}
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAO1C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,WAAoB,EACpB,UAAuB,EAAE;IAEzB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEvB,8DAA8D;IAC9D,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO;IACT,CAAC;IAED,8DAA8D;IAE9D,0CAA0C;IAC1C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,UAAU,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,IAAI,uBAAuB,CAAC,CAAC;YAC5D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,uDAAuD;QACvD,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;QACpD,IAAI,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,IAAI,CAAC,WAAW,IAAI,iBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QACrD,mBAAmB,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC;QACH,0BAA0B;QAC1B,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;QAE7C,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,WAAW,UAAU,MAAM,CAAC,iBAAiB,KAAK,CAAC,CAAC;QACrF,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjB,uBAAuB;QACvB,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,oCAAoC;QACpC,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACtE,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC9D,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;oEAEoE;AAEpE,SAAS,mBAAmB,CAAC,WAAoB;IAC/C,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IACzE,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;IACjF,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACtD,MAAM,CAAC,OAAO,EAAE,CAAC;IAEjB,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,CAAC,KAAK,CAAC,iBAAiB,WAAW,EAAE,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1B,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;IAC/E,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;IAClE,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC5E,MAAM,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;IAC/D,MAAM,CAAC,OAAO,EAAE,CAAC;IACjB,MAAM,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;AACpF,CAAC"}