Skip to main content

​
help — Command Overview

ultrarag --help

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. 
ultrarag build <CONFIG> [--log_level DEBUG|INFO|WARN|ERROR]
ParameterDescription
<CONFIG>Pipeline configuration file path, e.g., examples/pipeline.yaml
--log_levelLog level, default INFO

​
run — Execute Pipeline

Purpose: Start Pipeline execution. 
ultrarag run <CONFIG> [--param <PARAM_FILE>] [--is_demo] [--log_level DEBUG|INFO|WARN|ERROR]
ParameterDescription
<CONFIG>Path to pipeline.yaml to be executed
--param <PARAM_FILE>Custom parameter file path, overrides default files under parameter/
--is_demoEnable demo mode
--log_levelLog level, default INFO

​
show ui — Start Web Control Interface

Purpose: Start UI interface. 
ultrarag show ui [--host 127.0.0.1] [--port 5050] [--admin] [--log_level DEBUG|INFO|WARN|ERROR]
ParameterDescription
--hostWeb service binding IP (default 127.0.0.1)
--portWeb service port (default 5050)
--adminStart full administrator UI (including Pipeline Builder), default starts Chat mode only
--log_levelLog level, default INFO
Access http://<host>:<port> after startup to use the UI.