Skip to content
Get packs

Guide · Open source

How to use MagicMirror: setup, modules and what to know

Updated · written with AI from the project's own documentation and checked against our catalogue data

MagicMirror² is an open source, modular smart mirror platform. It turns a screen behind a one-way mirror, such as a hallway or bathroom mirror, into a display that shows information through installable modules. This guide explains what it is, how it is put together, the install starting point, and what to expect, so you can decide whether to set it up.

MagicMirror²MagicMirrorOrg/MagicMirror · ★ 24.2k · MIT

Quick start

  1. 1Check your setup. Confirm you are comfortable with a Linux or Raspberry Pi style setup and a command line, since the README describes a self-installed system.
  2. 2Clone the repository. Run git clone https://github.com/MagicMirrorOrg/MagicMirror to get the source code.
  3. 3Open the installation guide. Follow the installation instructions at docs.magicmirror.builders, which the README says hold the full steps.
  4. 4Build and run the software. Follow the build steps in the documentation, since the latest release is listed without binaries.
  5. 5Add modules. Enable the installable modules that show the information you want on your mirror.
  6. 6Mount the display behind the glass. Place the screen behind a one-way mirror in your hallway or bathroom, as the project describes.

What MagicMirror is and how it works

MagicMirror² is a smart mirror platform. A display sits behind a one-way mirror and shows information on the glass. The project describes itself as focused on a modular plugin system, with a growing list of installable modules that add content to the display.

It uses Electron as an application wrapper, so according to the README you do not need a separate web server or browser install.

Get the MagicMirror source code

The README's install command clones the repository from GitHub. Run this in the directory where you want the project to live.

The README lists no prerequisites, but it describes installing and configuring the system yourself. For the full installation instructions, the README points to the external documentation site at docs.magicmirror.builders.

git clone https://github.com/MagicMirrorOrg/MagicMirror

Choose a machine and install the software

The README does not list hardware requirements or build steps. It notes that the latest release is listed without binaries, so you should expect to build from source rather than download a ready-made installer.

The README mentions Linux and Raspberry Pi setups only in the sense that the project suits people comfortable with them. Follow the installation guide on the documentation site for the exact steps for your system.

  • Read the installation guide at docs.magicmirror.builders before you start.
  • Plan on a clone-and-build workflow, as the README describes.
  • Be comfortable with a command line and basic system configuration.

Add and configure modules

Modules are the pieces that show information on the mirror. The project describes a growing list of installable modules, and the platform is built around this plugin system.

The README does not list specific modules or configuration file names, so check the documentation site for how modules are enabled and set up.

Customize or write your own module

Because MagicMirror² is a modular plugin system, developers can write or customize modules. This suits people who want a home info display they can extend.

Contributions are welcome in the form of code, bug reports, documentation and translations. The full contribution guidelines are at docs.magicmirror.builders/about/contributing.html.

What people use it for

  • Showing home information on a hallway mirror.
  • Displaying useful information on a bathroom mirror.
  • Building a personal assistant display from installable modules.
  • Writing a custom module for a plugin system.
  • Extending a home info display over time as more modules become available.

Frequently asked questions

Is MagicMirror free?

Yes. The project is MIT licensed and the README says MagicMirror² is open source and free. The maintainers also accept optional donations to cover ongoing costs.

Do I need a web server or browser to run MagicMirror?

According to the README, no. It uses Electron as an application wrapper, so no separate web server or browser install is needed.

Is MagicMirror a finished product I can buy?

No. The README describes it as something you install and configure yourself, so it is not a finished consumer product with no setup.

Can I download a binary installer for MagicMirror?

The README says the latest release is listed without binaries, so the source is the starting point. Clone the repository and follow the installation guide.

Can I run MagicMirror on a Raspberry Pi?

The README's best-for list names people comfortable running a small Linux or Raspberry Pi setup as a suitable audience. For specific steps, use the documentation site.

What programming language is MagicMirror written in?

The project is written in JavaScript and released under the MIT licence. It has no listed comparable projects in this directory.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

MagicMirror is a good fit for hobbyists and developers who are comfortable with a command line and a Linux or Raspberry Pi style setup, and who want a home info display they can extend. If you want a ready-made product with no setup or binary downloads, look elsewhere.

Install options & downloads