> ## Documentation Index
> Fetch the complete documentation index at: https://miu.vanducng.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Complete installation guide for MIU packages

# 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

<Tabs>
  <Tab title="Unix/macOS">
    ```bash theme={null}
    curl -LsSf https://raw.githubusercontent.com/vanducng/miu-mono/main/scripts/install.sh | bash
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    irm https://raw.githubusercontent.com/vanducng/miu-mono/main/scripts/install.ps1 | iex
    ```
  </Tab>
</Tabs>

## Package Installation

### Using uv (Recommended)

[uv](https://github.com/astral-sh/uv) is a fast Python package manager:

```bash theme={null}
# Install as a tool
uv tool install miu-code

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

### Using pip

```bash theme={null}
# Core framework only
pip install miu-core

# CLI agent
pip install miu-code

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

## Available Packages

| Package      | PyPI Command               | Description                  |
| ------------ | -------------------------- | ---------------------------- |
| miu-core     | `pip install miu-core`     | Core framework library       |
| miu-code     | `pip install miu-code`     | AI coding agent with CLI/TUI |
| miu-examples | `pip install miu-examples` | Example applications         |
| miu-studio   | `pip install miu-studio`   | Web server and UI            |
| miu-mono     | `pip install miu-mono`     | Meta-package (all-in-one)    |

## Provider-Specific Extras

Install only the LLM providers you need:

```bash theme={null}
# 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:

```bash theme={null}
# 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:

```bash theme={null}
# Anthropic (default provider)
export ANTHROPIC_API_KEY="sk-ant-..."

# Google Gemini
export GOOGLE_API_KEY="..."

# OpenAI
export OPENAI_API_KEY="sk-..."
```

<Warning>
  Never commit API keys to version control. Use environment variables or `.env` files.
</Warning>

## Verifying Installation

```bash theme={null}
# Check version
miu --version

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

## Troubleshooting

<AccordionGroup>
  <Accordion title="Command not found">
    Ensure the installation directory is in your PATH. For uv tool installs, run `uv tool update-shell`.
  </Accordion>

  <Accordion title="API key errors">
    Verify your API key is set correctly with `echo $ANTHROPIC_API_KEY` (or your chosen provider).
  </Accordion>

  <Accordion title="Python version mismatch">
    MIU requires Python 3.11+. Check with `python --version`.
  </Accordion>
</AccordionGroup>