@mgzon/cli

MGZON CLI 🚀

  __  __    ____   _____   ___    _   _      ____   _       ___ 
 |  \/  |  / ___| |__  /  / _ \  | \ | |    / ___| | |     |_ _|
 | |\/| | | |  _    / /  | | | | |  \| |   | |     | |      | | 
 | |  | | | |_| |  / /_  | |_| | | |\  |   | |___  | |___   | | 
 |_|  |_|  \____| /____|  \___/  |_| \_|    \____| |_____| |___|

The official Command Line Interface for MGZON App Development Platform

📦 Installation

Option 1: Install via npm (Recommended for developers)

Install globally using npm:

npm install -g @mgzon/cli

Or using yarn:

yarn global add @mgzon/cli

Or using pnpm:

pnpm add -g @mgzon/cli

Option 2: Standalone Executables (No Node.js required)

Download the pre-built executables for your platform:

Linux

# Download and make executable
curl -L https://github.com/Mark-Lasfar/mgzon-cli/releases/download/v1.0.0/mgzon-linux -o mgzon
chmod +x mgzon
sudo mv mgzon /usr/local/bin/

macOS

# Download and make executable
curl -L https://github.com/Mark-Lasfar/mgzon-cli/releases/download/v1.0.0/mgzon-macos -o mgzon
chmod +x mgzon
sudo mv mgzon /usr/local/bin/

Windows

# Download from releases page and add to PATH
# https://github.com/Mark-Lasfar/mgzon-cli/releases/download/v1.0.0/mgzon-win.exe

Verify installation:

mz --version
# or
mgzon --version

Option 3: GUI Application

For users who prefer a graphical interface, download the MGZON GUI app:

• Linux: Download AppImage
• macOS: Download DMG
• Windows: Download EXE

The GUI provides the same functionality as the CLI but with a user-friendly interface.

GUI Features

• Dashboard: Quick access to common actions and system status
• Project Management: Create, open, and manage MGZON projects
• App Management: List, create, and manage your applications
• File Storage: Upload and manage files in MGZON storage
• Settings: Configure authentication, CLI settings, and preferences
• Terminal Output: Real-time command execution feedback

The GUI automatically detects and uses the bundled CLI executable for all operations.

Running the GUI

Linux (AppImage):

chmod +x MGZON.GUI-1.0.0.AppImage
./MGZON.GUI-1.0.0.AppImage

macOS (DMG): Double-click the downloaded DMG file and drag the app to Applications.

Windows (EXE): Double-click the downloaded EXE file to install and run.

🚀 Quick Start

Try the Demo Script

Run the included demo script to see common CLI usage:

# Make sure you're in the project directory
cd mgzon-cli

# Run the demo
./demo.sh

Manual Quick Start

# Create a new MGZON app
mz init my-app --template=nextjs

# Navigate to your app
cd my-app

# Install dependencies
npm install

# Start development server
mz serve

# Deploy to MGZON
mz deploy

🔧 Core Commands

🏗️ Project Management

• mz init [name] - Create a new MGZON app
• mz serve - Start local development server
• mz build - Build your app for production
• mz deploy - Deploy app to MGZON cloud

🔐 Authentication

• mz login - Login to your MGZON account
• mz logout - Logout from current session
• mz whoami - Show current user info

🔑 API Management

• mz keys:list - List your API keys
• mz keys:generate - Generate new API key
• mz keys:revoke <key-id> - Revoke an API key

📊 App Management

• mz apps:list - List your apps
• mz apps:create <name> - Create new app
• mz apps:info <app-id> - Show app details
• mz apps:delete <app-id> - Delete an app

📦 Database

• mz db:create - Create database schema
• mz db:migrate - Run database migrations
• mz db:seed - Seed database with sample data

📁 File Management

• mz storage:upload <file> - Upload file to storage
• mz storage:list - List storage files
• mz storage:delete <file-id> - Delete file

🎨 Templates

Available templates for mz init:

# Next.js template (default)
mz init my-app --template=nextjs

# React template
mz init my-app --template=react

# Vue.js template
mz init my-app --template=vue

# Static site template
mz init my-app --template=static

# E-commerce template
mz init my-app --template=ecommerce

⚙️ Configuration

Environment Setup

Create .mgzonrc in your project root:

{
  "projectId": "your-project-id",
  "apiKey": "your-api-key",
  "environment": "development"
}

Or use environment variables:

export MGZON_API_KEY="your-api-key"
export MGZON_PROJECT_ID="your-project-id"

Global Configuration

# Set default organization
mz config:set organization=my-org

# Set default environment
mz config:set environment=staging

# View all configurations
mz config:list

🔌 Plugins

Extend CLI functionality with plugins:

# Install plugin
mz plugins:install @mgzon/plugin-analytics

# List installed plugins
mz plugins:list

# Update plugins
mz plugins:update

🐛 Troubleshooting

Common Issues

• "Command not found" after installation

  # Add npm global bin to PATH
  export PATH="$PATH:$HOME/.npm-global/bin"
  # For fish shell: set -U fish_user_paths $HOME/.npm-global/bin $fish_user_paths
  

• Authentication failed

  # Clear authentication cache
  mz logout
  mz login
  

• Deployment failed

  # Check deployment logs
  mz logs --deployment=<deployment-id>
  
  # View build logs
  mz logs --build=<build-id>
  

🛠️ Development

Local Development

# Clone repository
git clone https://github.com/mgzon/mgzon-cli.git
cd mgzon-cli

# Install dependencies
npm install

# Build project
npm run build

# Run demo script
./demo.sh

# Link for local development
npm link

# Run tests
npm test

# Run in development mode
npm run dev -- --help

Project Structure

mgzon-cli/
├── src/
│   ├── commands/          # CLI commands
│   ├── lib/              # Core libraries
│   ├── utils/            # Utility functions
│   ├── types/            # TypeScript types
│   └── index.ts          # Entry point
├── dist/                 # Compiled output
├── tests/                # Test files
└── docs/                 # Documentation

📚 Documentation

Complete documentation is available in the docs/ directory:

• Installation Guide - Detailed installation instructions
• User Flow Guide - Step-by-step user workflows
• GUI-Backend Interaction - How the GUI communicates with services
• End-to-End Flow - Complete user journey from installation to execution
• Architecture Diagram - High-level system overview

For privacy and security reasons, implementation details are not exposed in this public repository. The documentation provides comprehensive guidance on usage and architecture without revealing sensitive code.

See our Privacy & Security Implementation Plan for details on our approach to protecting intellectual property and user data.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide.

• Fork the repository
• Create a feature branch: git checkout -b feature/my-feature
• Commit your changes: git commit -am 'Add new feature'
• Push to the branch: git push origin feature/my-feature
• Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Support

• 📧 Email: [e-mail]
• 🐛 Issues: GitHub Issues
• 💬 Discord: Join our community
• 🐦 Twitter: @mgzon_dev

Made with ❤️ by the MGZON Team