@dolphjs/cli 2.0.0 → 2.0.1

package/README.md

@@ -1,64 +1,89 @@
-# dolphjs cli
+# DolphJS CLI
 
-The dolphjs-cli is a tool used for efficient initialization and management of a dolphjs project.
+The `dolph` CLI is a powerful tool designed for the efficient initialization and management of DolphJS projects. Powered by Rust under the hood for blazing fast performance!
 
-## Commands
-
-**new**: the alias for this command is `n`. This command is used to initialize / start a new project. It takes the name of the project as an option
+## Installation
 
 ```bash
-dolph-cli new <project-name>
+npm install -g @dolphjs/cli
+# or using pnpm
+pnpm add -g @dolphjs/cli
 ```
 
-or use `' . '` in place of `<project-name>` to initialize the project in current directory.
+## Commands
 
-After this, you'll be prompted with few questions which would be used to configure your dolphjs project. Navigate to the project folder and run
+### `new`
+
+This command is used to initialize and start a new project. It takes the name of the project as an option.
 
 ```bash
-yarn
+dolph new <project-name>
 ```
 
-to install all packages .
+Or use `.` in place of `<project-name>` to initialize the project in your current directory:
+```bash
+dolph new .
+```
+
+After running this, you'll be prompted with interactive questions to configure your new DolphJS project (Language, Architecture, Database, etc.).
 
-**generate**: the alias for this command is `g` and is used to generate files and folders with setup code for :
+### `generate` (or `g`)
 
-- controllers
-- services
-- models
-- routes
+This command is used to quickly scaffold boilerplate files and folders with setup code. This ensures you are writing code the standard DolphJS way.
+
+```bash
+dolph generate [OPTIONS]
+```
 
-It is recommended to make use of the `generate` command when one wants to create these files because it generates code the dolphjs way. In a scenario when you want to create files for all of the above, let's say you want to write code for user logic and functionalities, use the `-a` flag, as in:
+**Options:**
+- `-a, --all <NAME>`: Generates all dolphjs files for the named parameter
+- `-c, --controller <NAME>`: Generates a dolphjs controller file
+- `-d, --dto <NAME>`: Generates a dolphjs dto file
+- `-e, --entity <NAME>`: Generates a dolphjs entity file
+- `-i, --input <NAME>`: Generates a dolphjs input file
+- `-k, --socket <NAME>`: Generates a dolphjs socket service and component
+- `-m, --model <NAME>`: Generates a dolphjs models file
+- `-r, --route <NAME>`: Generates a dolphjs routes file
+- `-s, --service <NAME>`: Generates a dolphjs service file
+- `-v, --resolver <NAME>`: Generates a dolphjs resolver file
+- `-y, --component <NAME>`: Generates a dolphjs spring component file
+
+**Example Usage:**
+
+To generate a full set of files (controller, service, model, routes, etc.) for a `user` feature:
+```bash
+dolph generate -a user
+```
 
+To generate just a specific file, such as a controller:
 ```bash
-dolph-cli g -a user
+dolph generate -c user
 ```
 
-the command above creates a service, controller, model and routes file for `user` and set's you up for writing business logic. Alternatively, you might want to create one of the files (controllers, models, services, routes) so you make use of their independent flags:
+### `build`
 
-- controller:
+Builds the dolphjs typescript project into a javascript project for production.
 
-  ```bash
-  dolph-cli g -c <name>
-  ```
+```bash
+dolph build
+```
 
-- service:
+### `start`
 
-  ```bash
-  dolph-cli g -s <name>
-  ```
+Starts the dolphjs server in production mode.
 
-- model:
+```bash
+dolph start
+```
 
-  ```bash
-  dolph-cli g -m <name>
-  ```
+### `watch`
 
-- route:
+Starts the dolphjs server in development mode (with hot-reloading).
 
-  ```bash
-  dolph-cli g -r <name>
-  ```
+```bash
+dolph watch
+```
 
 ## Credit
 
-dolphjs-cli is inspired by methane-cli [https://github.com/adedoyin-Emmanuel/methane-cli]
+dolphjs-cli was originally inspired by methane-cli.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dolphjs/cli",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "The dolphjs-cli is a tool for efficient initialization and management of a dolphjs project",
   "main": "./dist/index.js",
   "repository": "https://github.com/dolphjs/dolph-cli.git",