Skip to content

Mac guide

Kavin T edited this page Feb 13, 2026 · 2 revisions

๐Ÿ macOS Guide (Experimental)

macOS support is experimental. Some features may be limited.

๐Ÿ Installation

  • Requires Python 3.9+ and pip.
  • Recommended: Use a virtual environment or pipx.
pip install "simkl-mps[macos]"
# or with pipx
pipx install "simkl-mps[macos]"

๐Ÿš€ First Run

  1. Start the app:
    simkl-mps tray
    # or
    simkl-mps start
  2. Authenticate with SIMKL when prompted.
  3. The app runs in the system tray (menu bar).

๐ŸŽ›๏ธ Media Player Configuration

  • Critical: Configure your media players for accurate tracking.
  • See the Media Players Guide for setup steps for VLC, MPV, and others.

๐Ÿ› ๏ธ Tray Usage

  • Use the tray icon in the menu bar for status and controls.
  • After setup, daily usage is tray-first (CLI is optional).

๐Ÿž Troubleshooting

  • Grant accessibility and notification permissions in System Preferences if tray or notifications do not work.
  • For issues, see the Troubleshooting Guide.

โš ๏ธ Limitations

  • Some features are still in progress on macOS.
  • If you hit issues, please report them on GitHub with logs.

Clone this wiki locally