> ## 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.

# Quick Start

> Get started with MIU in under 5 minutes

# Quick Start Guide

Get MIU running on your system and start building AI-powered coding agents.

## Prerequisites

Before you begin, ensure you have:

* Python 3.11 or higher
* An API key from Anthropic, OpenAI, or Google

## Installation

<Tabs>
  <Tab title="Quick Install (Recommended)">
    **Unix/macOS:**

    ```bash theme={null}
    curl -LsSf https://raw.githubusercontent.com/vanducng/miu-mono/main/scripts/install.sh | bash
    ```

    **Windows (PowerShell):**

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

  <Tab title="Using uv">
    ```bash theme={null}
    # Install as a tool (recommended)
    uv tool install miu-code

    # Or run directly without installing
    uvx miu-code "read README.md"
    ```
  </Tab>

  <Tab title="Using pip">
    ```bash theme={null}
    # CLI agent
    pip install miu-code

    # Full installation with all extras
    pip install "miu-mono[all]"
    ```
  </Tab>
</Tabs>

## Configuration

Set your API key for the LLM provider you want to use:

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

# Google
export GOOGLE_API_KEY="..."

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

<Tip>
  Store your API keys in a `.env` file in your project root for convenience.
</Tip>

## Basic Usage

<Steps>
  <Step title="One-shot Query">
    Run a single command and get a response:

    ```bash theme={null}
    miu -q "explain this codebase"
    ```
  </Step>

  <Step title="Interactive REPL">
    Start an interactive session:

    ```bash theme={null}
    miu
    ```
  </Step>

  <Step title="TUI Mode">
    Launch the full terminal UI:

    ```bash theme={null}
    miu code
    ```
  </Step>

  <Step title="Custom Provider">
    Specify a different model:

    ```bash theme={null}
    miu --model anthropic:claude-opus-4-20250805 -q "summarize README.md"
    ```
  </Step>
</Steps>

## What's Next?

<CardGroup cols={2}>
  <Card title="Installation Details" icon="download" href="/getting-started/installation">
    Explore all installation options and extras
  </Card>

  <Card title="Architecture" icon="sitemap" href="/core-concepts/architecture">
    Learn about the modular architecture
  </Card>
</CardGroup>
