@muprotocol/cli

MUP (Model UI Protocol) CLI - Development tools for dynamic UI applications

Installation

npm install -g @muprotocol/cli

Usage

Initialize a new MUP project

mup init my-project
cd my-project

Start development server

mup serve
# or with custom port
mup serve --port 8080

Start development server with hot reload

mup dev

Validate MUP protocol messages

mup validate ./path/to/message.json

Build for production

mup build

Commands

mup init [project-name]

Initialize a new MUP project with the specified name.

Options:

• --template <template> - Project template to use
• --force - Overwrite existing files

mup serve

Start MUP development server.

Options:

• -p, --port <port> - Port number (default: 3000)
• -h, --host <host> - Host address (default: localhost)
• --protocol <protocol> - Protocol (ws|wss) (default: ws)
• -c, --config <config> - Configuration file path
• --ssl-cert <cert> - SSL certificate file (for wss)
• --ssl-key <key> - SSL private key file (for wss)
• -w, --watch - Watch for file changes and reload
• -v, --verbose - Verbose logging

mup dev

Start MUP development server with hot reload.

Options:

• -p, --port <port> - Port number (default: 3000)
• -h, --host <host> - Host address (default: localhost)
• -c, --config <config> - Configuration file path
• --open - Open browser automatically
• -v, --verbose - Verbose logging

mup validate <file>

Validate MUP protocol messages and components.

Options:

• --schema <schema> - Custom schema file
• --strict - Enable strict validation
• -v, --verbose - Verbose output

mup build

Build MUP project for production.

Options:

• -o, --output <dir> - Output directory (default: dist)
• -c, --config <config> - Configuration file path
• --minify - Minify output
• -v, --verbose - Verbose logging

Configuration

Create a mup.config.js file in your project root:

module.exports = {
  port: 3000,
  host: 'localhost',
  protocol: 'ws',
  timeout: 30000,
  // Additional configuration options
};

Examples

Basic WebSocket Server

# Initialize project
mup init chat-app
cd chat-app

# Start development server
mup serve --port 8080 --verbose

SSL/WSS Server

mup serve --protocol wss --ssl-cert cert.pem --ssl-key key.pem

Production Build

mup build --output ./dist --minify

Requirements

• Node.js >= 16.0.0
• npm >= 7.0.0

License

MIT

Contributing

See CONTRIBUTING.md for contribution guidelines.

Support

For issues and questions, please visit our GitHub repository.