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

# CLI

## help — Command Overview

```bash theme={null}
ultrarag --help
```

```text theme={null}
usage: ultrarag [-h] {build,run,show} ...

UltraRAG CLI

positional arguments:
  {build,run,show}
    build           Build the configuration
    run             Run the pipeline with the given configuration
    show            Show ui interfaces

options:
  -h, --help        show this help message and exit
```

***

## build — Build Configuration

**Purpose**: Automatically generate a unified parameter configuration file based on `pipeline.yaml`.

```bash theme={null}
ultrarag build <CONFIG> [--log_level DEBUG|INFO|WARN|ERROR]
```

| Parameter     | Description                                                      |
| ------------- | ---------------------------------------------------------------- |
| `<CONFIG>`    | Pipeline configuration file path, e.g., `examples/pipeline.yaml` |
| `--log_level` | Log level, default `INFO`                                        |

***

## run — Execute Pipeline

**Purpose**: Start Pipeline execution.

```bash theme={null}
ultrarag run <CONFIG> [--param <PARAM_FILE>] [--is_demo] [--log_level DEBUG|INFO|WARN|ERROR]
```

| Parameter              | Description                                                            |
| ---------------------- | ---------------------------------------------------------------------- |
| `<CONFIG>`             | Path to `pipeline.yaml` to be executed                                 |
| `--param <PARAM_FILE>` | Custom parameter file path, overrides default files under `parameter/` |
| `--is_demo`            | Enable demo mode                                                       |
| `--log_level`          | Log level, default `INFO`                                              |

***

## show ui — Start Web Control Interface

**Purpose**: Start UI interface.

```bash theme={null}
ultrarag show ui [--host 127.0.0.1] [--port 5050] [--admin] [--log_level DEBUG|INFO|WARN|ERROR]
```

| Parameter     | Description                                                                             |
| ------------- | --------------------------------------------------------------------------------------- |
| `--host`      | Web service binding IP (default `127.0.0.1`)                                            |
| `--port`      | Web service port (default `5050`)                                                       |
| `--admin`     | Start full administrator UI (including Pipeline Builder), default starts Chat mode only |
| `--log_level` | Log level, default `INFO`                                                               |

Access `http://<host>:<port>` after startup to use the UI.