Installation¶

Choose the installation that matches how you plan to use MUDIDI:

• Web dashboard: Docker is recommended on macOS, Windows, and Linux. Follow the Docker dashboard setup.
• CLI and YAML: native uv installation is recommended. It requires Python 3.11+ and Git; Windows uses WSL2.

CLI and YAML installation with uv¶

Install uv on macOS, Linux, or WSL2:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then clone MUDIDI and reproduce its locked environment:

git clone https://github.com/naarm-nlp/mudidi.git
cd mudidi
uv sync --frozen
cp .env.example .env

Add the API key for the provider used by your model:

GEMINI_API_KEY=replace-me
# OPENAI_API_KEY=replace-me
# ANTHROPIC_API_KEY=replace-me
# OPEN_ROUTER_API_KEY=replace-me

Credentials stay in .env; YAML run configurations must not contain secrets. Continue with the CLI quickstart.