Contract-Model-Model-View (CMMV)
Building scalable and modular applications using contracts.

Documentation • Report Issue

Description

The CMMV CLI is a versatile command-line tool designed to streamline the creation, development, and management of CMMV applications. It simplifies various tasks, such as generating the project structure, running the application in development mode, and preparing it for production with efficient building and bundling processes. This CLI promotes clean and modular architectural practices, encouraging well-organized and scalable applications.

For further details, explore the documentation.

Installation

The @cmmv/cli package provides a simple command-line interface for quickly scaffolding CMMV projects. You can use it with pnpm global installation or directly with npx for one-time use.

Install pnpm

If you don't have pnpm installed, you can install it using npm:

npm install -g pnpm

For additional installation options, refer to the pnpm installation guide.

Install CMMV CLI

Once pnpm is installed, you can install the CMMV CLI globally:

pnpm add -g @cmmv/cli

Once installed globally, you can run the cmmv command anywhere:

cmmv create <project-name>

Use with npx

For a one-time use without global installation, you can use npx:

pnpm dlx @cmmv/cli@latest create <project-name>

Commands

create

Generates a new CMMV project with a predefined structure. It provides options to enable or disable features like Vite, RPC, caching, and more.

cmmv create <project-name>

module

Creates a new module within an existing CMMV project. Modules are reusable components or feature-specific units of your application.

cmmv module <module-name>

contract

Create a new contract with the selected options such as cache, fields, validations

cmmv contract <contract-name>