@bayajidalam/apollo-cli 1.0.0 → 1.0.1

package/README.md

@@ -1,97 +1,70 @@
-# Apollo CLI
+# Apollo Gears CLI
 
-A CLI tool for scaffolding and managing Apollo backend projects (Express + TypeScript + Prisma + PostgreSQL).
+A powerful CLI tool for scaffolding and managing **Apollo Gears** backend projects (Express + TypeScript + Prisma + PostgreSQL).
 
 ## Installation
 
-### Global Installation
-
-To install the CLI globally:
+Install the CLI globally via npm:
 
 ```bash
-npm install -g apollo-cli
+npm install -g @bayajidalam/apollo-cli
 ```
 
-### Local Development Setup
+## Usage
+
+### 1. Initialize a New Project
 
-If you are developing this tool locally and want to test it:
+Create a complete backend project structure with Express, Prisma, and TypeScript configured.
 
-1.  **Build the CLI**:
-    ```bash
-    npm run build
-    ```
+```bash
+apollo-cli init my-new-project
+```
 
-2.  **Link it globally**:
-    ```bash
-    npm link
-    ```
-    This makes the `apollo-cli` command available in your terminal.
+### 2. Generate Modules
 
-## Usage
+Scaffold a new module (Controller, Service, Route, Interface, Validation, Constants) instantly.
 
-### 1. `generate` (alias: `g`)
+**Alias**: `g`
 
-Generates a new module structure including controller, service, route, interface, validation, and constants.
+**Important:** You must run this command *inside* your project directory.
 
-**Syntax:**
 ```bash
-apollo-cli generate module <ModuleName>
-# OR
-apollo-cli g module <ModuleName>
-```
+cd my-new-project
+# Using full command
+apollo-cli generate module User
 
-**Example:**
-Generate a `User` module:
-```bash
+# Using alias
 apollo-cli g module User
 ```
 
-This will create the following files in `src/app/modules/User`:
-- `user.controller.ts`
-- `user.service.ts`
-- `user.route.ts`
-- `user.interface.ts`
-- `user.validation.ts`
-- `user.constant.ts`
+This will create `src/app/modules/User` with:
+- `user.controller.ts`: Request handlers
+- `user.service.ts`: Business logic
+- `user.route.ts`: Express routes
+- `user.interface.ts`: TypeScript interfaces
+- `user.validation.ts`: Zod validation schemas
+- `user.constant.ts`: Module constants
 
-### 2. `build`
+### 3. Build for Production
 
-Builds the application for production deployment.
+Builds your TypeScript application to the `dist` folder.
 
-**Syntax:**
 ```bash
 apollo-cli build
 ```
 
-**What it does:**
-- Cleans the `dist` folder.
-- Compiles TypeScript files.
-- Copies `package.json`, `package-lock.json`, and `.env` to the `dist` folder.
+### 4. Prisma Utilities
 
-### 3. `prisma`
+Convenient wrappers for common Prisma commands.
 
-Helper commands for Prisma ORM.
-
-**Generate Client:**
 ```bash
+# Generate Prisma Client (runs: npx prisma generate)
 apollo-cli prisma generate
-```
-*(Runs `npx prisma generate`)*
 
-**Run Migrations:**
-```bash
+# Run Migrations (runs: npx prisma migrate dev)
 apollo-cli prisma migrate
 ```
-*(Runs `npx prisma migrate dev`)*
-
-## Development
 
-To run the CLI directly from source without building:
+## License
 
-```bash
-npx ts-node src/bin/index.ts <command>
-```
-Example:
-```bash
-npx ts-node src/bin/index.ts generate module Product
-```
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bayajidalam/apollo-cli",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "CLI tool for speed up backend projects",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -44,4 +44,4 @@
         "ts-node": "^10.9.2",
         "typescript": "^5.7.3"
     }
-}
+}