MetaBake CLI

8.5.4 · active · verified Wed Apr 22

MetaBake (mbake) CLI is an open-source, extensible low-code productivity bundler and builder designed for creating static websites and web applications, leveraging Pug and JAMstack principles. As of version 8.5.4, it provides out-of-the-box features like Pug compilation, livereload, Sass/SCSS compilation with autoprefixing, and TypeScript compilation. Its core differentiator is simplifying web development by abstracting away complex build configurations, allowing developers to write cleaner code quicker for various projects including static sites, custom elements, CMS, e-commerce, and CRUD applications. It facilitates a gradual adoption approach, enabling rapid development with a focus on simplicity and efficiency. While it doesn't specify a strict release cadence, it indicates active development. The tool focuses on generating static content that can be served efficiently via CDNs, using standard web technologies like HTML, CSS, and JavaScript, making it accessible to a broad audience.

Common errors

```
'mbake' command not found
```
cause The mbake package was not installed globally, or its installation path is not in the system's PATH.

fix Run `npm i -g mbake` to install the package globally. If already installed, verify your system's PATH environment variable.
```
Error: Node.js version X.Y.Z is not supported.
```
cause The currently active Node.js version is below the minimum requirement (>=14.0.0) specified by mbake.

fix Update your Node.js to version 14.0.0 or newer. For example, using nvm: `nvm install 16 && nvm use 16`.
```
Pug compilation failed: No such file or directory, 'index.pug'
```
cause The `mbake` command was executed in a directory that does not contain an `index.pug` file, or the path specified to `mbake` was incorrect.

fix Ensure you are running `mbake` from the root directory of your project, where `index.pug` and `dat.yaml` are located, or specify the correct path, e.g., `mbake -w ./my-site`.

Warnings

gotcha MetaBake requires Node.js version 14.0.0 or higher. Using an older Node.js version may lead to installation failures or unexpected runtime errors.
Fix: Upgrade your Node.js installation to version 14.0.0 or newer using a version manager like `nvm` or by downloading the latest LTS from nodejs.org.
gotcha For basic site compilation, `mbake` expects `index.pug` and `dat.yaml` files to be present in the root of the target directory. Missing these files will result in no output HTML.
Fix: Ensure `index.pug` and `dat.yaml` are correctly placed in the directory you are compiling. Refer to the documentation for specific file structure requirements for different features (e.g., Sass, TypeScript).
gotcha mbake is designed as a global CLI tool. Attempting to use it as a local `npm run` script without global installation or with an incorrect path may fail.
Fix: Always install `mbake` globally using `npm i -g mbake` to ensure the `mbake` command is available in your system's PATH.

Install

npm install mbake npm
yarn add mbake yarn
pnpm add mbake pnpm

Imports

mbake (Global CLI)
wrong:
```
import { mbake } from 'mbake'
```
correct:
```
npm i -g mbake
```
mbake is primarily a global CLI tool. It is installed via npm globally and invoked directly from the terminal, not imported as a JavaScript module.
Watcher with Livereload
wrong:
```
mbake --watch
```
correct:
```
mbake -w .
```
The `-w` flag activates the watcher, which includes livereload and starts a local development webserver. The `.` specifies the current directory to watch.
Sass Compilation
wrong:
```
mbake --sass
```
correct:
```
mbake -s .
```
The `-s` flag triggers Sass/SCSS compilation. Ensure you have a `style.yaml` file in your `assets` folder specifying the SCSS files to compile.
TypeScript Compilation
wrong:
```
mbake --typescript
```
correct:
```
mbake -t .
```
The `-t` flag compiles TypeScript files (`.ts`) in the specified directory, converting them to JavaScript.

Quickstart

This quickstart demonstrates how to install mbake globally and start a basic website with livereload using Pug and a data YAML file.

npm i -g mbake
cd my-website-folder
# Create index.pug and dat.yaml files here
# Example index.pug:
/* header
body
   p Hello #{key1} */
# Example dat.yaml:
/* key1: World */
mbake -w . # Starts watcher, livereload, and local server

view raw JSON →