Skip to content

CLI Reference

This section explains all commands exposed by the mirumoji CLI

Run mirumoji --help, or mirumoji <command> --help, for the same information in your terminal

mirumoji [COMMAND] [OPTIONS]
Backend & Image-Source Resolution

For the run commands (up, build, pull), the Transcription Backend and Image Source are evaluated in the following order of precedence. If one of the upper items is missing, the one right below it is used, until reaching a base default value

Transcription Backend

  • Flag (--transcribe / -t)

  • Saved Configuration File (mirumoji config show)

  • Base Default (modal)

Image Source

  • Flag (--pull / --build)

  • Saved Configuration File (mirumoji config show)

  • Base Default (pull)

Lifecycle Commands

up

Starts the Mirumoji Docker Compose Application

mirumoji up [OPTIONS]
Option Default Description
-t, --transcribe [local \| modal] Saved Config, Else modal Transcription Backend
--build / --pull Saved Config, Else --pull Build Images Locally / Pull Pre-Buil From Docker Hub
-d, --detach / --foreground --detach Run In The Background / Stream In The Foreground
What It Does

  • Resolves Your Transcription Backend / Image Source Options

  • Validates That Required Keys Are Configured And External Dependencies Are Present

  • Discovers Your IPv4 LAN IP For The Self-Signed Frontend Certificate

  • Builds / Pulls Images

  • Runs docker compose up

  • Prints local and LAN URLs

down

Stops The Docker Compose Application

mirumoji down [OPTIONS]
Option Default Description
-v, --volumes / --keep-volumes --keep-volumes Also Delete Data Bolumes (profiles, media, database)
-y, --yes off Skip Confirmation Prompt When Deleting Volumes

status

Shows The Running Docker Compose Services + Their Health As A Table

mirumoji status

logs

Streams Logs From The Whole Docker Compose Application Or A Single Service

mirumoji logs [SERVICE] [OPTIONS]
Argument / Option Default Description
SERVICE all Scope To One Service (frontend or backend)
-f, --follow off Follow New Output
--tail N all Show Only Last N Lines

pull

Pulls Pre-Built Images From Docker Hub For The Chosen Transcription Backend

mirumoji pull [-t local|modal]

build

Clones / Updates The Managed Mirumoji GitHub Repository Checkout And Builds The Frontend + Backend Images Locally For The Chosen Backend

mirumoji build [-t local|modal]

doctor

Reports The Status Of Every External Dependency (Docker, Compose, Git, NVIDIA GPU + NVIDIA Contianer Toolkit, Flet, Flutter)

mirumoji doctor

gui

Launches The Desktop GUI Launcher

Requires The gui Extra (pip install mirumoji[gui])

mirumoji gui

render

Writes A Resolved docker-compose.yaml From The Packaged Template For A Chosen Transcription Backend And Image Source Without Running The Applocation

Used for Manual Installs

mirumoji render [OPTIONS]
Option Default Description
-t, --transcribe [local \| modal] Prompts Tranascription Backend To Target
--build / --pull --pull Reference Locally Built Tags Or Docker Hub Images
-o, --output PATH docker-compose.yaml Where To Write The File

Development Commands

dev server

Runs The FastAPI Server Directly With uvicorn (no Docker), Using The App Factory

Intended For Development → Requires The server Extra (pip install mirumoji[server])

mirumoji dev server [OPTIONS]
Option Default Description
--host 0.0.0.0 Interface To Bind
--port 8000 Port To Listen On
--reload off Reload On Code Changes

dev up

Builds The Frontend + Backend Images From A Local Mirumoji Repo Checkout And Runs The Docker Compose Application, Without Updating The Checkout

Intended For Development → Builds From An Arbitrary Path Rather Than The Managed Checkout That build Uses

mirumoji dev up [OPTIONS]
Option Default Description
-t, --transcribe [local \| modal] Saved Config, Else modal Transcription Backend
-p, --path PATH Path.cwd() Path To The Local Mirumoji Repo Checkout
-d, --detach / --foreground --detach Run In The Background / Stream In The Foreground

Configuration Commands

Managed Configuration File

  • All Settings Are Kept In A Single Managed .env File

  • It's Changed Only Through The Following Commands

  • Run Commands (up, build, pull) Never Modify It

mirumoji config set <KEY> <VALUE> # (1)!
mirumoji config delete <KEY> # (2)!
mirumoji config show # (3)!
mirumoji config path # (4)!
mirumoji config import <PATH> # (5)!
mirumoji config clear # (6)!
  1. Set Or Update One Variable. Rejects Unknown Keys, and Validates The Value Of Deployment Keys Against Their Allowed Options
  2. Remove One Variable
  3. Print Current Config (Secrets Masked)
  4. Print The Location Of The Configuration File
  5. Merge an Existing .env File
  6. Remove Everything

Configurable Keys

Key Values Default Description
MIRUMOJI_TRANSCRIBE_BACKEND local, modal modal Where Transcription / Conversion Runs
MIRUMOJI_IMAGE_SOURCE pull, build pull Pull Pre-Built Images / Build Images Locally

All Optional → Set Any Or All To Enable LLM Features

Key Description
OPENAI_API_KEY Enable GPT Models
ANTHROPIC_API_KEY Enable Claude Models
GEMINI_API_KEY Enable Gemini Models
MIRUMOJI_LLM_BASE_URL Use A Custom OpenAI-Compatible LLM Server Endpoint
MIRUMOJI_LLM_API_KEY Key For The Custom Endpoint Above (Leave Empty If Not Applicable)

Required Only For The modal Transcription Backend

Key Default Description
MODAL_TOKEN_ID Required Modal Token ID
MODAL_TOKEN_SECRET Required Modal Token Secret
MIRUMOJI_MODAL_GPU A10G GPU Type To Use In The Modal Containers
MODAL_FORCE_BUILD 0 Force Modal to Rebuild Its Cached App Image

Optional Overrides → The Server Has Sensible Defaults For All Of These

Key Description
MIRUMOJI_LOGGING_LEVEL Python Logging Level For The Backend
MIRUMOJI_MODAL_IMAGE Docker Hub Image That The Modal Containers Run
MIRUMOJI_SRT_DEFAULT_SYS_MSG Default LLM System Message For Subtitle Refinement
MIRUMOJI_BREAKDOWN_DEFAULT_SYS_MSG Default LLM System Message For Word Breakdowns

Examples

mirumoji config set MIRUMOJI_TRANSCRIBE_BACKEND local
mirumoji config set MODAL_TOKEN_ID abc123
mirumoji config show