Skip to content

Command-Line Arguments

Mumimo accepts a variety of CLI arguments to control connection, paths, logging, and runtime behaviour. Every argument has a corresponding environment variable that serves as a fallback.

Argument Env Var Default Description
--config MUMIMO_CONFIG_FILE Path to a custom config file
--data-dir MUMIMO_DATA_DIR Data directory path
--log-dir MUMIMO_LOG_DIR Log directory path
--plugins-dir MUMIMO_PLUGINS_DIR Custom plugins directory
--ip MUMBLE_IP Mumble server IP address
--port MUMBLE_PORT Mumble server port
--password MUMBLE_PASSWORD Mumble server password
--user MUMIMO_USER_ID Bot’s Mumble username
--cert MUMIMO_USER_CERT Path to the bot’s certificate file
--safe false Load only safe-mode plugins
--verbose false Enable debug-level logging
--quiet false Restrict logging to warnings and above

Connect to a local server on the default port with verbose logging:

Terminal window
mumimo --ip 127.0.0.1 --port 64738 --password secret --verbose

Use a custom config and data directory:

Terminal window
mumimo --config /etc/mumimo/config.toml --data-dir /var/lib/mumimo --ip 10.0.0.5 --port 64738

Run in safe mode (loads only core_commands and bot_commands):

Terminal window
mumimo --ip 10.0.0.5 --port 64738 --safe

When the same setting is defined in multiple places, Mumimo resolves it in this order — highest priority wins:

  1. CLI arguments — always take top priority.
  2. Environment variables — used when no CLI argument is provided.
  3. Config file (config.toml) — the persistent configuration.
  4. Built-in defaults — hard-coded fallbacks.

This means you can keep secrets in environment variables, tune behaviour in the config file, and still override anything on the fly with a CLI flag.

Flag Effective Level Notes
(none) info Default
--verbose debug Detailed output for troubleshooting
--quiet warning Only warnings and errors