Skip to content

GUI Setup

This section will teach you how to get mirumoji running with the Desktop Launcher

The Desktop Launcher Isn't The App

  • The main Mirumoji application runs via Docker Compose

  • The Desktop Launcher is just a friendly front door to it which automatically runs all the Docker commands,checks if the external dependencies needed by Mirumoji are installed in your machine, and helps you manage the main application more easily

  • You still need Docker to be installed and running

Getting The Launcher

There are 2 Ways To Run The Desktop Launcher

Pick The One That Fits You

Download the pre-built desktop bundles for your OS from the GitHub Release Page

  • Each bundle is mirumoji-<version>-<os>.zip folder containing a standalone executable

  • No Dependencies Required

Install the mirumoji python package

pip install mirumoji[gui]

  • Needs the mirumoji[gui] extra dependencies

  • Requires you to have Python>=3.10 installed in your machine

Starting The Launcher

  • Unzip the mirumoji-<version>-<os>.zip folder

Open the unzipped folder and run Mirumoji.exe

Open Mirumoji.app

Unsigned Build

Since the build is unsigned, the first launch needs Gatekeeper cleared

  • Right-Click App → Open

  • Alternatively, run xattr -dr com.apple.quarantine Mirumoji.app in the terminal

Make the executable runnable and start it 

chmod +x mirumoji
./mirumoji

Run the GUI Command 

mirumoji gui

Using the Launcher

The desktop launcher Dashboard

Dashboard → Start, stop, build, and view status in one place

The Desktop Launcher Has 4 Panels

Panel What It Does
Dashboard Start / Stop / Build Images / Watch Status
Environment Run Dependency Checks (Same as mirumoji doctor)
Settings Choose The Transcription Backend / Image Source, Set LLM / Modal API Keys + Advanced Overrides
Logs Stream + Filter The Docker Compose Application's Logs

Typical First Run

The launcher Settings panel

Settings → Pick Transcription Backend + Image Source / Store LLM / Modal Keys