create-nexo 1.8.0 → 1.8.1
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 +33 -25
- package/dist/bin/nexo.js +51 -51
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# 🚀 NEXO CLI
|
|
4
4
|
**Next-generation, extensible CLI for scaffolding and orchestrating modern frontend projects**
|
|
5
5
|
|
|
6
|
-
[](https://www.npmjs.com/package/create-nexo)
|
|
7
7
|
[](https://www.npmjs.com/package/create-nexo)
|
|
8
8
|
[](LICENSE)
|
|
9
9
|
[](https://nodejs.org/)
|
|
@@ -20,8 +20,9 @@ NEXO combines a cutting-edge tech stack with a powerful orchestration engine for
|
|
|
20
20
|
|
|
21
21
|
- ⚛️ **Modern Foundation** — Native **React 19** support with **React Compiler**, built for speed on the leading **Vite** engine.
|
|
22
22
|
- 📜 **TypeScript First** — Strict **TS 5.7+** standards out of the box for ultimate type safety and reliability.
|
|
23
|
-
- 🎨 **Visual Excellence** — Premier styling with **Tailwind CSS v4**,
|
|
24
|
-
- 🧱 **
|
|
23
|
+
- 🎨 **Visual Excellence** — Premier styling with **Tailwind CSS v4**, and official **shadcn/ui** and **HeroUI** integrations.
|
|
24
|
+
- 🧱 **Structured Architecture** — Professionally scaffolded **Feature-based** architecture patterns for scalability.
|
|
25
|
+
- 🔌 **Backend Integration (BaaS)** — Built-in setup for **Supabase**, **Firebase**, **Clerk**, and **Prisma** with auto-generated clients.
|
|
25
26
|
- 🧠 **AI-Native Context** — Auto-generated `.nexo/ai-context.md` for perfect alignment with modern AI coding agents.
|
|
26
27
|
- 📚 **Smart Documentation** — Auto-generated `DOCS.md` with direct links to official documentation for your chosen stack.
|
|
27
28
|
- ⚡ **Instant Setup** — Zero-latency I/O with memory-resident `package.json` management; saved exactly once per project.
|
|
@@ -31,7 +32,6 @@ NEXO combines a cutting-edge tech stack with a powerful orchestration engine for
|
|
|
31
32
|
- 🚀 **Atomic Orchestration** — Combined Git operations and parallel module loading for lightning-fast command execution.
|
|
32
33
|
- 🛠️ **Unified Maintenance** — Total project health, security, and bundle auditing via the single `check` command.
|
|
33
34
|
- 👀 **Dry Run Safety** — Preview every file and structural change before they ever touch your disk.
|
|
34
|
-
- 📦 **Zero-Dependency Binary** — Entire CLI is bundled into a single file (~340KB) for instant installation and startup.
|
|
35
35
|
- 🚚 **Multi-PM Support** — Native detection and optimization for **pnpm**, **Bun**, and **Yarn**.
|
|
36
36
|
- 🏗️ **Template Cloning** — Lightning-fast scaffolding using **GitHub templates** with `giget` integration and **3-retry resilience**.
|
|
37
37
|
- 🛡️ **Pre-Write Safety** — Permission checks, disk space validation (100MB+), and Windows **MAX_PATH** protection.
|
|
@@ -40,32 +40,33 @@ NEXO combines a cutting-edge tech stack with a powerful orchestration engine for
|
|
|
40
40
|
- 📊 **Auto Version Resolution** — Automatically fetches latest package versions with graceful fallback to stable defaults.
|
|
41
41
|
- 📈 **Install Stats** — Detailed performance metrics and caching summaries after every installation.
|
|
42
42
|
- 🎨 **UI RTL-Ready** — Specialized support for **Ant Design** RTL configuration and professional Arabic typography.
|
|
43
|
+
- 🔐 **Environment Templates** — Auto-generates `.env.example` with required variables for your chosen backend services.
|
|
43
44
|
|
|
44
45
|
---
|
|
45
46
|
|
|
46
47
|
## 📂 Project Structure
|
|
47
48
|
|
|
48
|
-
NEXO generates a clean, scalable structure tailored to your choices (e.g.,
|
|
49
|
+
NEXO generates a clean, scalable structure tailored to your choices (e.g., Feature-based).
|
|
49
50
|
|
|
50
51
|
```plaintext
|
|
51
52
|
my-app/
|
|
52
53
|
├── public/ # Static assets
|
|
53
54
|
├── src/
|
|
54
55
|
│ ├── app/ # App providers & global layout
|
|
55
|
-
│ ├── assets/ # Images, fonts, icons
|
|
56
|
-
│ ├── components/ # Shared UI components
|
|
57
|
-
│ ├── config/ # Environment & app config
|
|
58
56
|
│ ├── features/ # Feature-based modules (slices)
|
|
59
|
-
│ ├── hooks/ # Shared React hooks
|
|
60
|
-
│ ├── lib/ # Utils, helpers, and third-party setups
|
|
61
57
|
│ ├── pages/ # Route components
|
|
62
|
-
│ ├──
|
|
63
|
-
│ ├──
|
|
58
|
+
│ ├── shared/ # Shared components, hooks, and utils
|
|
59
|
+
│ │ ├── components/
|
|
60
|
+
│ │ ├── hooks/
|
|
61
|
+
│ │ ├── utils/
|
|
62
|
+
│ │ └── types/
|
|
63
|
+
│ ├── lib/ # Generated clients (Supabase/Firebase/Prisma)
|
|
64
64
|
│ ├── App.tsx # Main entry component
|
|
65
65
|
│ └── main.tsx # Application entry point
|
|
66
66
|
├── .nexo/ # AI Context & Metadata
|
|
67
67
|
├── .cursorrules # AI-specific coding rules
|
|
68
68
|
├── DOCS.md # Documentation for your specific stack
|
|
69
|
+
├── .env.example # Environment templates
|
|
69
70
|
├── index.html
|
|
70
71
|
├── package.json
|
|
71
72
|
└── vite.config.ts
|
|
@@ -73,6 +74,8 @@ my-app/
|
|
|
73
74
|
|
|
74
75
|
---
|
|
75
76
|
|
|
77
|
+
---
|
|
78
|
+
|
|
76
79
|
## 📦 Quick Start
|
|
77
80
|
|
|
78
81
|
```bash
|
|
@@ -84,27 +87,26 @@ npx create-nexo@latest my-app -p dashboard
|
|
|
84
87
|
|
|
85
88
|
# Or using the npm create shorthand
|
|
86
89
|
npm create nexo@latest
|
|
87
|
-
|
|
88
|
-
# Global installation (optional)
|
|
89
|
-
npm install -g create-nexo
|
|
90
|
-
nexo create my-app
|
|
91
90
|
```
|
|
92
91
|
|
|
93
92
|
---
|
|
94
93
|
|
|
95
94
|
## 🎯 Command Suite
|
|
96
95
|
|
|
96
|
+
> [!TIP]
|
|
97
|
+
> **Execution**: Always use `npx create-nexo` for the default command or `npx -p create-nexo nexo [command]` for specific actions.
|
|
98
|
+
|
|
97
99
|
| Command | Description |
|
|
98
100
|
|---------|-------------|
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
103
|
-
| `
|
|
104
|
-
| `nexo wizard` | Guided project creation for beginners |
|
|
105
|
-
| `nexo presets` | List and use optimized project presets |
|
|
106
|
-
| `nexo check` | Run system & project health checks |
|
|
107
|
-
| `nexo update` | Self-update Nexo CLI to the latest version |
|
|
101
|
+
| `npx create-nexo` | Start a new project with interactive prompts |
|
|
102
|
+
| `npx create-nexo --audit` | Enable security audit during installation |
|
|
103
|
+
| `npx create-nexo --strict` | Enable strict dependency resolution |
|
|
104
|
+
| `npx create-nexo --template` | Clone a project from a GitHub template |
|
|
105
|
+
| `npx create-nexo --rtl` | Create an Arabic & RTL project instantly |
|
|
106
|
+
| `npx -p create-nexo nexo wizard` | Guided project creation for beginners (Alias: `w`) |
|
|
107
|
+
| `npx -p create-nexo nexo presets` | List and use optimized project presets |
|
|
108
|
+
| `npx -p create-nexo nexo check` | Run system & project health checks (Flags: `--system`, `--project`) |
|
|
109
|
+
| `npx -p create-nexo nexo update` | Self-update Nexo CLI to the latest version |
|
|
108
110
|
|
|
109
111
|
---
|
|
110
112
|
|
|
@@ -125,6 +127,12 @@ nexo create my-app
|
|
|
125
127
|
- **TanStack Query** — Advanced caching and data synchronization.
|
|
126
128
|
- **TanStack Router / React Router** — Type-safe navigation.
|
|
127
129
|
|
|
130
|
+
### Backend & Services
|
|
131
|
+
- **Supabase** — Open source Firebase alternative.
|
|
132
|
+
- **Firebase** — Google's mobile and web application development platform.
|
|
133
|
+
- **Clerk** — Complete user management and authentication.
|
|
134
|
+
- **Prisma** — Next-generation ORM for Node.js and TypeScript.
|
|
135
|
+
|
|
128
136
|
---
|
|
129
137
|
|
|
130
138
|
## 🧠 AI Integration
|