Basic Usage

Overview

MMPM is modeled after the apt command line interface, and contains many analogous subcommands.

version

Display MMPM's version:

mmpm version

update

Initialize the Package List and check for updates (similar to apt update)

mmpm update

upgrade

Upgrade any packages/applications which have upgrades available

mmpm upgrade

search

Search for keywords or categories

mmpm search sports

install/remove

Install/remove a MagicMirror Package:

mmpm install -y MMM-mmpm
mmpm remove -y MMM-mmpm

list

List packages or categories

mmpm list --installed        # currently installed packages
mmpm list --all              # list all packages
mmpm list --categories       # list all package categories
mmpm list --upgradable       # list packages/applications which have available upgrades

show

Display extra detail about the package your interested in:

mmpm show MMM-mmpm

Get details from the repository:

mmpm show --remote MMM-mmpm

ui

Install/Remove the MMPM UI (pm2 is required):

mmpm ui install -y
mmpm ui remove -y

mm-ctl

Requires MMM-mmpm be installed:

mmpm mm-ctl --status          # lists all active modules in MagicMirror
mmpm mm-ctl --hide 4          # hides the module based on it's key shown in status (the example here is key '4')
mmpm mm-ctl --show 4          # similar to '--hide'
mmpm mm-ctl --start           # starts MagicMirror
mmpm mm-ctl --stop            # stops MagicMirror
mmpm mm-ctl --restart         # restarts MagicMirror

env

Dump the current MMPM Environment settings

mmpm env

open

Edit configuration files and open web applications

mmpm open --env              # open the MMPM env configuration file
mmpm open --config           # open the MagicMirror config.js
mmpm open --css              # open the MagicMirror custom.css
mmpm open --ui               # open the MMPM UI
mmpm open --mm-wiki          # open the MagicMirror wiki page
mmpm open --mmpm-wiki        # open the MMPM wiki page
mmpm open --magicmirror      # open MagicMirorr

guided-setup

Interactive setup of MMPM

mmpm guided-setup

mm-pkg

Add Custom Packages to your local database. See Custom Packages for more details.

logs

Display MMPM logs to stdout:

mmpm logs
mmpm logs --tail    # to tail the logs and follow them live

completion

See Tab Completion for more details.

db

Display information about the database

mmpm db --info    # display metadata including when the database was last updated
mmpm db --dump    # dump the entire database to stdout in JSON format