@mbc-cqrs-serverless/cli

A command-line interface for the MBC CQRS Serverless framework. Quickly scaffold new projects, generate code, and manage your serverless CQRS applications.

Features

• Project Scaffolding: Create production-ready CQRS applications with a single command
• Code Generation: Generate modules, controllers, services, entities, and DTOs
• Version Management: Install specific framework versions or use the latest
• Local Development: Built-in commands for starting local development servers

Installation

Global Installation (Recommended)

npm install -g @mbc-cqrs-serverless/cli

Version-Specific Installation

# Latest stable release
npm install -g @mbc-cqrs-serverless/cli

# Beta release
npm install -g @mbc-cqrs-serverless/cli@beta

# Specific version
npm install -g @mbc-cqrs-serverless/[email protected]

Verify installation:

mbc --version

Quick Start

Create and run a new CQRS application in minutes:

# Create a new project
mbc new my-cqrs-app

# Navigate to project
cd my-cqrs-app

# Install dependencies
npm install

# Start local development (run in separate terminals)
npm run offline:docker   # Terminal 1: Start Docker services
npm run migrate          # Terminal 2: Run database migrations
npm run offline:sls      # Terminal 3: Start serverless offline

Commands

mbc new [name[@version]]

Generate a new CQRS application.

Alias: n

Examples:

# Create project in current directory (prompts for name)
mbc new

# Create project with a specific name
mbc new my-app

# Create project with a specific framework version
mbc new [email protected]

# Use alias
mbc n my-app

mbc generate <schematic> [name]

Generate code elements using schematics.

Alias: g

Options:

• -d, --dry-run - Report actions without writing files
• --mode <mode> - Operation mode: sync or async (default: async)
• --schema / --no-schema - Enable/disable schema generation

Available Schematics:

| Name | Alias | Description | |------|-------|-------------| | module | mo | Create a module | | controller | co | Create a controller | | service | se | Create a service | | entity | en | Create an entity | | dto | dto | Create a DTO |

Examples:

# Generate a new module
mbc generate module todo

# Generate a controller (using alias)
mbc g co todo

# Generate a service with async mode
mbc g service todo --mode async

# Dry run to preview changes
mbc g module order --dry-run

mbc start

Start the application with Serverless Framework.

Alias: s

mbc start
# or
mbc s

mbc ui-common

Add MBC CQRS UI common components to your project.

Alias: ui

Options:

• -p, --pathDir <string> - Path for common-ui (required)
• -b, --branch <string> - Branch name (default: main)
• --auth <string> - Auth method: HTTPS or SSH (default: SSH)
• --token <string> - Token for HTTPS auth (format: tokenId:tokenPassword)
• -c, --component <string> - Component to install: all, appsync, or component (default: all)
• --alias - Alias to common-ui

Example:

mbc ui-common -p ./src/common-ui -c all

mbc install-skills

Install Claude Code skills for MBC CQRS Serverless development.

Alias: skills

Options:

• -p, --project - Install to project directory (.claude/skills/) instead of personal (~/.claude/skills/)
• -f, --force - Overwrite existing skills
• -l, --list - List available skills without installing
• -c, --check - Check if updates are available without installing

Examples:

# Install to personal skills directory (available in all projects)
mbc install-skills

# Install to project directory (shared with team via git)
mbc install-skills --project

# List available skills
mbc install-skills --list

# Force overwrite existing skills
mbc install-skills --force

# Check for updates
mbc install-skills --check

# Using alias
mbc skills -p

Upgrading Skills:

Skills do not auto-update. To upgrade to the latest version:

# Update CLI to latest version
npm update -g @mbc-cqrs-serverless/cli

# Check if updates are available
mbc install-skills --check

# Force reinstall to get latest version
mbc install-skills --force

Available Skills:

| Skill | Description | |-------|-------------| | /mbc-generate | Generate boilerplate code (modules, services, controllers, DTOs, handlers) | | /mbc-review | Review code for best practices and anti-patterns (20 patterns) | | /mbc-migrate | Guide version migrations and breaking changes | | /mbc-debug | Debug and troubleshoot common issues |

Project Structure

The CLI creates a standardized project structure optimized for CQRS:

my-cqrs-app/
├── src/
│   ├── app.module.ts           # Root application module
│   ├── main.ts                 # Application entry point
│   ├── todo/                   # Example module (optional)
│   │   ├── todo.module.ts      # Module definition
│   │   ├── todo.controller.ts  # REST controller
│   │   ├── todo.service.ts     # Business logic
│   │   ├── dto/                # Data transfer objects
│   │   │   ├── create-todo.dto.ts
│   │   │   └── update-todo.dto.ts
│   │   └── entity/             # Entity definitions
│   │       └── todo.entity.ts
│   ├── prisma/                 # Prisma ORM configuration
│   │   ├── schema.prisma       # Database schema
│   │   └── prisma.service.ts   # Prisma service
│   └── helpers/                # Utility functions
├── infra-local/                # Local infrastructure config
│   └── cognito-local/          # Local Cognito setup
├── test/
│   ├── e2e/                    # End-to-end tests
│   └── unit/                   # Unit tests
├── .env.example                # Environment template
├── docker-compose.yml          # Docker services
├── package.json                # Dependencies
├── serverless.yml              # Serverless Framework config
└── tsconfig.json               # TypeScript configuration

Development Workflow

1. Create Project

mbc new my-cqrs-app
cd my-cqrs-app
npm install

2. Configure Environment

cp .env.example .env
# Edit .env with your settings

3. Start Local Infrastructure

# Start Docker services (DynamoDB Local, LocalStack, etc.)
npm run offline:docker

4. Initialize Database

# Run Prisma migrations
npm run migrate

5. Start Development Server

# Start Serverless Offline
npm run offline:sls

6. Generate New Components

# Add a new module
mbc g module order

# Add related components
mbc g controller order
mbc g service order
mbc g entity order
mbc g dto order

Related Packages

| Package | Description | |---------|-------------| | @mbc-cqrs-serverless/core | Core CQRS framework | | @mbc-cqrs-serverless/sequence | Sequence number generation | | @mbc-cqrs-serverless/task | Async task processing | | @mbc-cqrs-serverless/master | Master data management | | @mbc-cqrs-serverless/tenant | Multi-tenancy support | | @mbc-cqrs-serverless/import | Data import utilities | | @mbc-cqrs-serverless/ui-setting | UI configuration |

Documentation

Full documentation is available at https://mbc-cqrs-serverless.mbc-net.com/

• Getting Started
• CLI Reference
• Build a Todo App Tutorial

Troubleshooting

Version Not Found

mbc new [email protected]
# Error: Version not found

Solution: Check available versions on npm.

Project Creation Fails

mbc new my-project
# Error: Directory not empty

Solution: Use a new directory or remove existing files first.

Permission Denied

npm install -g @mbc-cqrs-serverless/cli
# EACCES: permission denied

Solution: Fix npm permissions or use a Node version manager like nvm.

License

Copyright © 2024-2025, Murakami Business Consulting, Inc. https://www.mbc-net.com/

This project is under the MIT License.