Skip to main content

​
Installation Guide

MIU offers flexible installation options depending on your use case.

​
System Requirements

  • Python: 3.11 or higher
  • Operating Systems: macOS, Linux, Windows (via WSL)
  • Package Manager: pip, uv, or pipx

​
Quick Install Scripts

curl -LsSf https://raw.githubusercontent.com/vanducng/miu-mono/main/scripts/install.sh | bash

​
Package Installation

uv is a fast Python package manager: 
# Install as a tool
uv tool install miu-code

# Run without installing
uvx miu-code "your query"

​
Using pip

# Core framework only
pip install miu-core

# CLI agent
pip install miu-code

# All packages
pip install "miu-mono[all]"

​
Available Packages

PackagePyPI CommandDescription
miu-corepip install miu-coreCore framework library
miu-codepip install miu-codeAI coding agent with CLI/TUI
miu-examplespip install miu-examplesExample applications
miu-studiopip install miu-studioWeb server and UI
miu-monopip install miu-monoMeta-package (all-in-one)

​
Provider-Specific Extras

Install only the LLM providers you need: 
# Single provider
pip install "miu-core[anthropic]"
pip install "miu-core[google]"
pip install "miu-core[openai]"

# All providers
pip install "miu-core[all]"

​
Development Installation

For contributing or development: 
# Clone repository
git clone https://github.com/vanducng/miu-mono.git
cd miu-mono

# Install dependencies with uv
uv sync

# Run tests
uv run pytest

# Lint and type check
uv run ruff check .
uv run mypy packages/

​
Environment Variables

Configure your API keys: 
# Anthropic (default provider)
export ANTHROPIC_API_KEY="sk-ant-..."

# Google Gemini
export GOOGLE_API_KEY="..."

# OpenAI
export OPENAI_API_KEY="sk-..."
Never commit API keys to version control. Use environment variables or .env files.

​
Verifying Installation

# Check version
miu --version

# Test with a simple query
miu -q "Hello, what can you help me with?"

​
Troubleshooting

Ensure the installation directory is in your PATH. For uv tool installs, run uv tool update-shell.
Verify your API key is set correctly with echo $ANTHROPIC_API_KEY (or your chosen provider).
MIU requires Python 3.11+. Check with python --version.