Minimaz CLI

About

Minimaz is a minimal, low-dependency static site builder and project initializer focused on speed, simplicity, and clean output. It supports HTML, CSS, JavaScript, and TypeScript (.ts → .js), with optional bundling and minification.

Designed for small static sites, utility tools, prototypes, and teams that want reproducible minimal build systems.

Features

Installation

Run directly using npx or as a global module:

npx minimaz init my-site
cd my-site
npx minimaz build

Global installation:

npm install -g minimaz-cli
minimaz init my-site

During npm install, a post-install script runs to finalize setup automatically.

Project Structure

my-site/
├── dist/              # Output folder (generated)
├── public/            # Static assets
├── src/               # HTML, CSS, JS, TS files
├── minimaz.config.json
├── package.json       # Optional (if npm init used)
├── .gitignore
└── ...

Configuration

{
    "input": {
        "dir": "./src",
        "mapping": {
            "pages": "",
            "public": ""
        },
        "externals": {
            "node_modules/bootstrap-icons/font/fonts": "public/fonts"
        },
        "exclude": []
    },
    "output": {
        "dir": "./dist",
        "replace": {
            "/": "/public/"
        },
        "css": {
            "bundling": true,
            "minify": true
        },
        "js": {
            "bundling": true,
            "minify": true
        },
        "html": {
            "minify": true
        }
    }
}

• input.externals → Include library assets without copying them into src
• output.replace → Define asset path replacements for the build
• bundling → Scans imports/requires to merge code into single files

Commands

# Build and minify the project
minimaz build (mz b)

# Delete the dist folder
minimaz clear (mz c)

# Validate HTML, CSS, JS, TS, and JSON files
minimaz validate --path=/path/to/file

# Initialize a new project
minimaz init <project-name> [options] (mz i)

Options:
  -t, --template <name>    # Use specific template (default: 'default')
  --npm                    # Init npm (creates package.json & runs install)
  --git                    # Initialize git repository
  --gitprovider <provider> # 'github', 'gitlab', or existing repo URL
  --gitremote <url>        # Specify custom remote URL

# Save current folder as a new template
minimaz template [folder-path] (mz t)

# List all global templates
minimaz template --list (-l)

# Delete a template (asks for confirmation)
minimaz template --delete <name> (-d)

# Update templates from current folder or defaults
minimaz template --update [name] (-u)

# Setup or overwrite global settings
minimaz config (mz config --overwrite)

# Show help for a specific command
minimaz help <command> (mz h build)

# Show Minimaz CLI version
minimaz version (mz v)

Upcoming & Future Features

Planned improvements and roadmap direction. Scope is intentionally controlled to preserve simplicity.

npm install -g @minimaz/cli

minimaz template <repo-url>

minimaz convert input.jpg --to webp

minimaz analyze

<block src="header.html"></block>

Global Folder

~/.minimaz/templates

Use templates to quickly initialize consistent projects across environments.

Links

• GitHub Repository
• npm Package