https://github.com/bee-mar/mmpm
MagicMirror Package Manager
https://github.com/bee-mar/mmpm
angular cli magicmirror magicmirror2 monaco-editor mypy python python3 raspberry-pi raspberry-pi-3 socketio
Last synced: 29 days ago
JSON representation
MagicMirror Package Manager
- Host: GitHub
- URL: https://github.com/bee-mar/mmpm
- Owner: Bee-Mar
- License: mit
- Created: 2019-05-19T18:18:51.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-11T23:28:45.000Z (about 2 years ago)
- Last Synced: 2024-04-12T09:09:36.775Z (about 2 years ago)
- Topics: angular, cli, magicmirror, magicmirror2, monaco-editor, mypy, python, python3, raspberry-pi, raspberry-pi-3, socketio
- Language: Python
- Size: 19.1 MB
- Stars: 171
- Watchers: 5
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
| Author | Contact |
| --------------- | --------------------------------- |
| Brandon Marlowe | bpmarlowe-software@protonmail.com |
`MMPM`, the MagicMirror Package Manager is a self updating command line and graphical interface designed to simplify the installation, removal, and maintenance of MagicMirror packages.
The MagicMirror Package Manager is featured as an alternative installation method on the [MagicMirror Documentation](https://docs.magicmirror.builders/getting-started/installation.html#alternative-installation-methods).
## Quick Installation Guide
MMPM can be installed as a Docker image, or through `pip`.
### [Docker](https://hub.docker.com/r/karsten13/mmpm/)
```sh
docker pull karsten13/mmpm
```
### [pip](https://pypi.org/project/mmpm/)
```sh
python3 -m pip install --upgrade mmpm
```
### Ensure Your PATH is Correct
```sh
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc && source ~/.bashrc
```
## Features
- Manage packages: install, remove, update, and upgrade.
- Search and view package details.
- Add custom packages (similar to Ubuntu PPAs).
- CLI tab-autocompletion.
- Easy access to MMPM and MagicMirror configuration.
- Manage MagicMirror: install, upgrade, remove.
- Control MagicMirror modules: hide/show ([details](https://github.com/Bee-Mar/mmpm/wiki/Status,-Hide,-Show-MagicMirror-Modules))
- Control MagicMirror state: start, stop, restart (supports npm with automatic X11/Wayland/Windows detection, pm2, docker-compose).
- Mirror Preview: drag-and-drop interface for arranging modules across MagicMirror regions, with direct read/write of `config.js`.
## Look to the [Wiki](https://github.com/Bee-Mar/mmpm/wiki)
Key Pages:
- [Installation & Removal](https://github.com/Bee-Mar/mmpm/wiki/MMPM-Installation-&-Removal)
- [UI Installation & Removal](https://github.com/Bee-Mar/mmpm/wiki/MMPM-UI-Installation-&-Removal)
- [Environment Variables](https://github.com/Bee-Mar/mmpm/wiki/MMPM-Environment-Variables) (**Extremely** important)
- [Hide/Show MagicMirror Modules](https://github.com/Bee-Mar/mmpm/wiki/Status,-Hide,-Show-MagicMirror-Modules)