@mbc-cqrs-serverless/cli 0.1.49-beta.0 → 0.1.50-beta.0

package/README.md

@@ -4,11 +4,11 @@
 
 ## Description
 
-The MBC CLI is a command-line interface tool that helps you to initialize your mbc-cqrs-serverless applications.
+The MBC CLI is a command-line interface tool that helps you initialize and manage MBC CQRS Serverless applications. It provides commands for project creation, version management, and development workflow automation.
 
 ## Installation
 
-To install `mbc` command, run:
+To install the `mbc` command globally, run:
 
 ```bash
 npm install -g @mbc-cqrs-serverless/cli
@@ -16,86 +16,117 @@ npm install -g @mbc-cqrs-serverless/cli
 
 ## Usage
 
-### `mbc new|n [projectName@version]`
+### Project Creation
 
-There are 3 usages for the new command:
+The CLI provides flexible options for creating new projects:
 
-- `mbc new`
-  - Creates a new project in the current folder using a default name with the latest framework version.
-- `mbc new [projectName]`
-  - Creates a new project in the `projectName` folder using the latest framework version.
-- `mbc new [projectName@version]`
-  - If the specified version exists, the CLI uses that exact version.
-  - If the provided version is a prefix, the CLI uses the latest version matching that prefix.
-  - If no matching version is found, the CLI logs an error and provides a list of available versions for the user.
+```bash
+mbc new [projectName[@version]]
+```
 
-To change current directory
+#### Basic Usage Examples
+
+1. Create a new project in the current directory:
+```bash
+mbc new
+```
+
+2. Create a project with a specific name:
+```bash
+mbc new my-cqrs-app
+```
 
+3. Create a project with a specific version:
 ```bash
-cd [projectName]
+mbc new my-cqrs-app@0.1.45
 ```
 
-## Run the Development Server
-1. Run npm run build to the build project using development mode.
-2. Open in other terminal session and run npm run offline:docker
-3. Open in other terminal session and run npm run migrate to migrate RDS and dynamoDB table
-4. Finally, run npm run offline:sls to start serverless offline mode.
+### Project Structure
+
+The CLI creates a standardized project structure:
 
-After the server runs successfully, you can see:
+```
+my-cqrs-app/
+├── src/
+│   ├── commands/       # Command handlers
+│   ├── events/        # Event handlers
+│   ├── interfaces/    # TypeScript interfaces
+│   └── services/      # Business logic services
+├── test/
+│   ├── e2e/          # End-to-end tests
+│   └── unit/         # Unit tests
+├── package.json
+└── serverless.yml    # Serverless Framework configuration
+```
 
+### Development Workflow
+
+1. After creating a project, install dependencies:
 ```bash
-DEBUG[serverless-offline-sns][adapter]: successfully subscribed queue "http://localhost:9324/101010101010/notification-queue" to topic: "arn:aws:sns:ap-northeast-1:101010101010:MySnsTopic"
-Offline Lambda Server listening on http://localhost:4000
-serverless-offline-aws-eventbridge :: Plugin ready
-serverless-offline-aws-eventbridge :: Mock server running at port: 4010
-Starting Offline SQS at stage dev (ap-northeast-1)
-Starting Offline Dynamodb Streams at stage dev (ap-northeast-1)
-
-Starting Offline at stage dev (ap-northeast-1)
-
-Offline [http for lambda] listening on http://localhost:3002
-Function names exposed for local invocation by aws-sdk:
-           * main: serverless-example-dev-main
-Configuring JWT Authorization: ANY /{proxy+}
-
-   ┌────────────────────────────────────────────────────────────────────────┐
-   │                                                                        │
-   │   ANY | http://localhost:3000/api/public                               │
-   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
-   │   ANY | http://localhost:3000/swagger-ui/{proxy*}                      │
-   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
-   │   ANY | http://localhost:3000/{proxy*}                                 │
-   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
-   │                                                                        │
-   └────────────────────────────────────────────────────────────────────────┘
-
-Server ready: http://localhost:3000 🚀
+cd my-cqrs-app
+npm install
 ```
 
-You can also use several endpoints:
+2. Build the project:
+```bash
+npm run build
+```
 
-- API gateway: http://localhost:3000
-- Offline Lambda Server: http://localhost:4000
-- HTTP for lambda: http://localhost:3002
-- Step functions: http://localhost:8083
-- DynamoDB: http://localhost:8000
-- DynamoDB admin: http://localhost:8001
-- SNS: http://localhost:4002
-- SQS: http://localhost:9324
-- SQS admin: http://localhost:9325
-- Localstack: http://localhost:4566
-- AppSync: http://localhost:4001
-- Cognito: http://localhost:9229
-- EventBridge: http://localhost:4010
-- Simple Email Service: http://localhost:8005
-- Run `npx prisma studio` to open studio web: http://localhost:5000
+3. Start local development environment:
+```bash
+npm run offline:docker  # Start local infrastructure
+npm run migrate        # Run database migrations
+npm run offline:sls    # Start serverless offline
+```
 
+### Available Commands
 
+- `mbc new`: Create a new project
+- `mbc version`: Display CLI version
+- `mbc help`: Show command help
+- `mbc list`: List available project templates
 
+### Configuration
+
+The CLI supports configuration through:
+- Command line arguments
+- Environment variables
+- Configuration files
+
+Example configuration file (`.mbcrc.json`):
+```json
+{
+  "defaultTemplate": "basic",
+  "region": "ap-northeast-1",
+  "stage": "dev"
+}
+```
 
 ## Documentation
 
-Visit https://mbc-cqrs-serverless.mbc-net.com/ to view the full documentation.
+Visit https://mbc-cqrs-serverless.mbc-net.com/ to view the full documentation, including:
+- Detailed CLI commands and options
+- Project setup and configuration
+- Development server setup
+- Available endpoints and services
+
+## Troubleshooting
+
+Common issues and solutions:
+
+1. Version not found:
+```bash
+mbc new myapp@999.999.999
+# Error: Version not found. Available versions: [0.1.45, 0.1.44, ...]
+```
+Solution: Use `mbc list versions` to see available versions.
+
+2. Project creation fails:
+```bash
+mbc new my-project
+# Error: Directory not empty
+```
+Solution: Use a new directory or remove existing files.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbc-cqrs-serverless/cli",
-  "version": "0.1.49-beta.0",
+  "version": "0.1.50-beta.0",
   "description": "a CLI to get started with MBC CQRS serverless framework",
   "keywords": [
     "mbc",
@@ -15,7 +15,7 @@
     "fargate",
     "step-functions",
     "sqs",
-    "typpescript"
+    "typescript"
   ],
   "bin": {
     "mbc": "./dist/index.js"
@@ -49,5 +49,5 @@
   "devDependencies": {
     "@faker-js/faker": "^8.3.1"
   },
-  "gitHead": "4fb13a54044022d4423830c985b51dd8ec58259a"
+  "gitHead": "d61475400eb1b00a1c427769875d2f056e48c73c"
 }