MMPM Custom Packages

Overview

Custom Packages in MMPM allow adding private or public packages not listed in the MagicMirror 3rd Party Wiki. Once added to your local database, they can be installed, upgraded, and removed just like any marketplace package.

Required Information

Every Custom Package needs a title, author, repository URL, and description. You can add one through the CLI with mmpm custom-pkg add (alias: mmpm pkg add), or in the UI under the "Custom Packages" menu.

Adding Custom Packages

Interactive Mode

Run the command with no options and MMPM will prompt you for each field:

mmpm custom-pkg add

The repository must be a valid URL beginning with http://, https://, or git@ (so private repositories accessed over SSH work too).

Single Command Entry

mmpm custom-pkg add \
  -t "my-module" \
  -a "my-author" \
  -r "https://github.com/my-author/my-module" \
  -d "my-description"

Long-form flags work as well: --title, --author, --repo, --desc. Any field you omit will be prompted for interactively.

Installing Custom Packages

Now that the package is in your local database, install it as you normally would:

mmpm add -y my-module      # 'mmpm install' also works

Removing Custom Packages

Uninstall it like you would any other MagicMirror package:

mmpm remove -y my-module

Then remove it from the database (multiple names accepted; -y skips the confirmation prompt):

mmpm custom-pkg remove -y my-module